POST
/
v2
/
document
curl --request POST \
  --url https://api.deepl.com/v2/document \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form target_lang=DE \
  --form file=@document.docx
{
  "document_id": "04DE5AD98A02647D83285A36021911C6",
  "document_key": "0CB0054F1C132C1625B392EADDA41CB754A742822F6877173029A6C487E7F60A"
}

Authorizations

​
Authorization
string
header
required

Authentication with Authorization header and DeepL-Auth-Key authentication scheme. Example: DeepL-Auth-Key <api-key>

Body

multipart/form-data

Response

200
application/json

The document function returns a JSON object containing the ID and encryption key assigned to the uploaded document. Once received by the server, uploaded documents are immediately encrypted using a uniquely generated encryption key. This key is not persistently stored on the server. Therefore, it must be stored by the client and sent back to the server with every subsequent request that refers to this particular document.

The response is of type object.