Authorizations
Authentication with Authorization
header and DeepL-Auth-Key
authentication scheme. Example: DeepL-Auth-Key <api-key>
Path Parameters
The document ID that was sent to the client when the document was uploaded to the API.
Body
The document encryption key that was sent to the client when the document was uploaded to the API.
"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.
A unique ID assigned to the uploaded document and the requested translation process. The same ID that was used when requesting the translation status.
"04DE5AD98A02647D83285A36021911C6"
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 processedtranslating
- the translation is currently ongoingdone
- the translation is done and the translated document is ready for downloaderror
- an irrecoverable error occurred while translating the document
queued
, translating
, done
, error
"done"
Estimated number of seconds until the translation is done.
This parameter is only included while status
is "translating"
.
The number of characters billed to your account. The characters will only be billed after a successful download request.
1337
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.
"Only available if document status is error"