DEdeepl
TranslateDocuments

Check Document Status

Changed on

Retrieve the translation status of an uploaded document. Poll this endpoint until the status is done, then download the result. The response includes an estimated remaining time while the document is still translating.

post/v2/document/{document_id}

Request

  • Base URL
    https://api.deepl.com
  • URL
    https://api.deepl.com/v2/document/{document_id}
  • Auth
    API key in header Authorization

Path parameters

document_idstring required

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

Request body

document_keystring required

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

Example request

{
  "document_key": "0CB0054F1C132C1625B392EADDA41CB754A742822F6877173029A6C487E7F60A"
}

Response

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.

document_idstring required

A unique ID assigned to the uploaded document and the requested translation process. The same ID that was used when requesting the translation status.

status'queued' | 'translating' | 'done' | 'error' required

A short description of the state the document translation process is currently in. Possible values are:

  • queued - the translation job is waiting in line to be processed
  • translating - the translation is currently ongoing
  • done - the translation is done and the translated document is ready for download
  • error - an irrecoverable error occurred while translating the document
seconds_remaininginteger

Estimated number of seconds until the translation is done. This parameter is only included while status is "translating".

billed_charactersinteger

The number of characters billed to your account. The characters will only be billed after a successful download request.

error_messagestring

A short description of the error, if available. Note that the content is subject to change. This parameter may be included if an error occurred during translation.

Example response

{
  "document_id": "04DE5AD98A02647D83285A36021911C6",
  "status": "done",
  "billed_characters": 1337,
  "error_message": "Only available if document status is error"
}

Changes

  • c7c91cfac5c0Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status