Document Translation

HTTP request

POST /v1/translate/document

Authorization

OAuth2PasswordBearer

Authorization: OAuth2PasswordBearer

Request Body schema: multipart/form-data

KEY
TYPE
VALUE

file

File

Upload the document to be translated. Supported formats include DOCX, PDF, PPTX, and XLSX.

file_type

String

The type of the file being translated. Supported formats include DOCX, PDF, PPTX, and XLSX.

original_lang

String

The original language of the content. Optional but recommended for better accuracy.

dest_lang

String

The target language for translation.

process_mode

String

Describes how the file should be processed 'replace', 'append'.

style_mode

Interger

Default: 0

Specifies the styling preference for the translation output. Influences formatting and presentation.

translate_type

String

Specifies the translation engine or version to be used. Paraphrase, Professional

is_translate_images

Bool

Flag indicating whether images within the document should also be translated.

tone

String

Tone of the translation, if applicable

domain

String

The domain or field of the content, which can help in choosing specialized translation models.

bilingual_text_style__font

String

Used to set the font for the bilingual translation mode and when process_mode=append

bilingual_text_style__color

String

Used to set the color for the bilingual translation mode and when process_mode=append

dictionary

String

Optional custom dictionary in JSON format to be used for the translation, specifying word-level translations.

custom_prompt

String

Custom prompt to be used for the translation

Response

200: Success

Response schema: application/json

KEY
VALUE

status_code

200

content

{ "data": { "task_id": "0d05c89e6f2c472ab86b291516e8e466" }, "errors": [], "error_description": "", "start_time": "2024-03-11 13:05:42.080757", "end_time": "2024-03-11 13:05:42.348086", "status": "success" }

400: Bad Request

KEY
VALUE

status_code

400

content

{ "data": {}, "errors": [ "Error" ], "error_description": "Error while sending message. Please check server!", "start_time": "yyyy-mm-dd hh-mm-ss utc+7", "end_time": "yyyy-mm-dd hh-mm-ss utc+7" }

401: Authentication Error

KEY
VALUE

status_code

401

content

{ "detail": "Not authenticated" }

Response schema: application/json

detail

Last updated