OpenAPI spec for document translation
Last updated
Last updated
This page contains only a set of guides that is auto-generated from DeepL's OpenAPI file.
For more detail about document translation, including information about request parameters, please see the Translate documents entry.
/document
Language of the text to be translated. If this parameter is omitted, the API will attempt to detect the language of the text and translate it.
ENBG, CS, DA, DE, EL, EN, ES, ET, FI, FR, HU, ID, IT, JA, KO, LT, LV, NB, NL, PL, PT, RO, RU, SK, SL, SV, TR, UK, ZHThe language into which the text should be translated.
DEBG, CS, DA, DE, EL, EN-GB, EN-US, ES, ET, FI, FR, HU, ID, IT, JA, KO, LT, LV, NB, NL, PL, PT-BR, PT-PT, RO, RU, SK, SL, SV, TR, UK, ZH, ZH-HANSThe document file to be translated. The file name should be included in this part's content disposition. As an alternative, the filename parameter can be used. The following file types and extensions are supported:
docx - Microsoft Word Documentpptx - Microsoft PowerPoint Documentxlsx - Microsoft Excel Documentpdf - Portable Document Formathtm / html - HTML Documenttxt - Plain Text Documentxlf / xliff - XLIFF Document, version 2.1srt - SRT DocumentThe name of the uploaded file. Can be used as an alternative to including the file name in the file part's content disposition.
File extension of desired format of translated file, for example: docx. If unspecified, by default the translated file will be in the same format as the input file.
Sets whether the translated text should lean towards formal or informal language.
This feature is only available for certain target languages. Setting this parameter
with a target language that does not support formality will fail, unless one of the
prefer_... options are used.
Possible options are:
default (default)more - for a more formal languageless - for a more informal languageprefer_more - for a more formal language if available, otherwise fallback to default formalityprefer_less - for a more informal language if available, otherwise fallback to default formalityprefer_moredefault, more, less, prefer_more, prefer_lessA unique ID assigned to a glossary.
def3a26b-3e84-45b3-84ae-0c0aaf3525f7/document/{document_id}
The document ID that was sent to the client when the document was uploaded to the API.
04DE5AD98A02647D83285A36021911C6The document encryption key that was sent to the client when the document was uploaded to the API.
0CB0054F1C132C1625B392EADDA41CB754A742822F6877173029A6C487E7F60A/document/{document_id}/result
The document ID that was sent to the client when the document was uploaded to the API.
04DE5AD98A02647D83285A36021911C6The document encryption key that was sent to the client when the document was uploaded to the API.
0CB0054F1C132C1625B392EADDA41CB754A742822F6877173029A6C487E7F60ANo body