DeepL Translator

The module provides integration with DeepL Translator

Settings

Parameter
Default
Description

Auth Key

-

Auth Key from your DeepL account

Use Pro version?

Off

For paid users only

Business processes

DeepL Translator: Translate Text

Input

  • sourse_lang (enum) - the language of the text to be translated;

  • target_lang (enum) - the language into which the text should be translated;

  • text (string) - text to be translated. Only UTF8-encoded plain text is supported;

  • split_sentences (boolean) - sets whether the translation engine should first split the input into sentences. This is enabled by default;

  • glossary_id (string) - specify the glossary to use for the translation. Important: This requires the source_lang parameter to be set and the language pair of the glossary has to match the language pair of the request.

Output

  • text (string) - the translated text.

DeepL Translator: Translate document

Input

  • sourse_lang (enum) - the language of the text to be translated;

  • target_lang (enum) - the language into which the text should be translated;

  • document (file) - the document file to be translated.

Output

  • document_id (string) - a unique ID assigned to the uploaded document and the translation process;

  • document_key (string) - a unique key that is used to encrypt the uploaded document as well as the resulting translation on the server side.

DeepL Translator: Check translation status

Input

  • document_id (string) - a unique ID assigned to the document and the translation process;

  • document_key (string) - the document encryption key that was sent to the client when the document was uploaded to the API.

Output

  • document_id (string) - a unique ID assigned to the document and the translation process;

  • status (enum) - 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

  • seconds_remaining (integer) - estimated number of seconds until the translation is done. This parameter is only included while the translation is ongoing.

DeepL Translator: Downloading translated documents

Input

  • document_id (string) - a unique ID assigned to the document and the translation process;

  • document_key (string) - the document encryption key that was sent to the client when the document was uploaded to the API.

  • name (string) - name of file.

Output

  • document (file) - downloaded file

Last updated