Download Translated Document 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}/result
Auth header

Once the status of the document translation process is done, the result can be downloaded.

For privacy reasons the translated document is automatically removed from the server once it was downloaded and cannot be downloaded again.

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/octet-stream

    The document is provided as a download. There is no other data included in the response besides the document data. The content type used in the response corresponds to the document type.

    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.
  • 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 application/json

    Trying to download a document using a non-existing document ID or the wrong document key will result in a 404 error. As stated above, documents can only be downloaded once before they are deleted from the server and their document ID is invalidated.

    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 attribute Show response attribute object
    • message string

      detailed error message
  • 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.

  • 503 application/json

    A 503 result will be returned if the user tries to download a translated document that is currently being processed and is not yet ready for download. Please make sure to check that the document status is 'done' before trying to send a download 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.

    Hide response attribute Show response attribute object
    • message string

      detailed error message
  • 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}/result 
curl \
 --request POST 'https://api.deepl.com/v2/document/04DE5AD98A02647D83285A36021911C6/result' \
 --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/result' \
 --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)
binary document data 
{"summary" => "OK", "description" => "binary document data"}
Response examples (404) 
{
  "message": "Document not found"
}
Response examples (503) 
{
  "message": "Document already downloaded"
}