Check Document Status Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://bump.sh/polo/hub/about-mcp/doc/deepl/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "Deepl MCP server": {
    "url": "https://bump.sh/polo/hub/about-mcp/doc/deepl/mcp"
  }
}
Close
POST /v2/document/{document_id}
Auth header

Retrieve the current status of a document translation process. If the translation is still in progress, the estimated time remaining is also included in the response.

Path parameters

  • document_id string Required

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

Body Required

  • document_key string Required

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

Body Required

  • document_key string Required

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

Responses

  • 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.

    Hide headers attribute Show headers attribute
    • X-Trace-ID

      A unique identifier for the request that can be included in bug reports to DeepL support.

    Hide response attributes Show response attributes object
    • document_id string 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 string 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

      Values are queued, translating, done, or error.

    • seconds_remaining integer

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

    • billed_characters integer

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

    • error_message string

      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.
  • 400

    Bad request. Please check error message and your parameters.

    Hide headers attribute Show headers attribute
    • X-Trace-ID

      A unique identifier for the request that can be included in bug reports to DeepL support.

  • 403

    Authorization failed. Please supply a valid DeepL-Auth-Key via the Authorization header.

    Hide headers attribute Show headers attribute
    • X-Trace-ID

      A unique identifier for the request that can be included in bug reports to DeepL support.

  • 404

    The requested resource could not be found.

    Hide headers attribute Show headers attribute
    • X-Trace-ID

      A unique identifier for the request that can be included in bug reports to DeepL support.

  • 413

    The request size exceeds the limit.

    Hide headers attribute Show headers attribute
    • X-Trace-ID

      A unique identifier for the request that can be included in bug reports to DeepL support.

  • 429

    Too many requests. Please wait and resend your request.

    Hide headers attribute Show headers attribute
    • X-Trace-ID

      A unique identifier for the request that can be included in bug reports to DeepL support.

  • 456

    Quota exceeded. The character limit has been reached.

    Hide headers attribute Show headers attribute
    • X-Trace-ID

      A unique identifier for the request that can be included in bug reports to DeepL support.

  • 500

    Internal error.

    Hide headers attribute Show headers attribute
    • X-Trace-ID

      A unique identifier for the request that can be included in bug reports to DeepL support.

  • 504

    Resource currently unavailable. Try again later.

    Hide headers attribute Show headers attribute
    • X-Trace-ID

      A unique identifier for the request that can be included in bug reports to DeepL support.

  • 529

    Too many requests. Please wait and resend your request.

    Hide headers attribute Show headers attribute
    • X-Trace-ID

      A unique identifier for the request that can be included in bug reports to DeepL support.

POST /v2/document/{document_id} 
curl \
 --request POST 'https://api.deepl.com/v2/document/04DE5AD98A02647D83285A36021911C6' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'document_key=0CB0054F1C132C1625B392EADDA41CB754A742822F6877173029A6C487E7F60A'
curl \
 --request POST 'https://api.deepl.com/v2/document/04DE5AD98A02647D83285A36021911C6' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"document_key":"0CB0054F1C132C1625B392EADDA41CB754A742822F6877173029A6C487E7F60A"}'
Request example 
{"document_key" => "0CB0054F1C132C1625B392EADDA41CB754A742822F6877173029A6C487E7F60A"}
Request examples 
{
  "document_key": "0CB0054F1C132C1625B392EADDA41CB754A742822F6877173029A6C487E7F60A"
}
Response examples (200) 
{
  "document_id": "04DE5AD98A02647D83285A36021911C6",
  "status": "translating",
  "seconds_remaining": 20
}
{
  "document_id": "04DE5AD98A02647D83285A36021911C6",
  "status": "done",
  "billed_characters": 1337
}
{
  "document_id": "04DE5AD98A02647D83285A36021911C6",
  "status": "queued"
}
{
  "document_id": "04DE5AD98A02647D83285A36021911C6",
  "status": "error",
  "message": "Source and target language are equal."
}