POST
/
v2
/
document
/
{document_id}
curl --request POST \
  --url https://api.deepl.com/v2/document/{document_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data document_key=0CB0054F1C132C1625B392EADDA41CB754A742822F6877173029A6C487E7F60A
{
  "document_id": "04DE5AD98A02647D83285A36021911C6",
  "status": "translating",
  "seconds_remaining": 20
}

Authorizations

​
Authorization
string
header
required

Authentication with Authorization header and DeepL-Auth-Key authentication scheme

Path Parameters

​
document_id
string
required

The document ID that was sent to the client when the document was uploaded to the API.

Body

Response

200
application/json

The document status request returns a JSON object containing the document ID that was used in the request as well as string indicating the current status of the translation process. While the translation is running, the estimated number of seconds remaining until the process is done is also included in the response.

The response is of type object.

POST
/
v2
/
document
/
{document_id}
curl --request POST \
  --url https://api.deepl.com/v2/document/{document_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data document_key=0CB0054F1C132C1625B392EADDA41CB754A742822F6877173029A6C487E7F60A
{
  "document_id": "04DE5AD98A02647D83285A36021911C6",
  "status": "translating",
  "seconds_remaining": 20
}

Authorizations

​
Authorization
string
header
required

Authentication with Authorization header and DeepL-Auth-Key authentication scheme

Path Parameters

​
document_id
string
required

The document ID that was sent to the client when the document was uploaded to the API.

Body

Response

200
application/json

The document status request returns a JSON object containing the document ID that was used in the request as well as string indicating the current status of the translation process. While the translation is running, the estimated number of seconds remaining until the process is done is also included in the response.

The response is of type object.