Document Directory

Create translation

Create a translation task.

curl
1curl -X POST 'https://otranslator.com/api/v1/translation/create' \
2--header 'Authorization: [yourSecretKey]' \
3--form 'fromLang=English' \
4--form 'toLang=Simplified Chinese' \
5--form 'glossary=[GlossaryName]' \
6--form 'file=@bitcoin.pdf'

Request Parameters

Supported languages:
English、Simplified Chinese、Traditional Chinese (Hong Kong)、Traditional Chinese (Taiwan)、Traditional Chinese、Spanish、Portuguese、Russian、Italian、French、German、Ukrainian、Swedish、Japanese、Japanese (Honorifics)、Japanese (Humble)、Japanese (Polite)、Polish、Turkish、Korean、Malay、Lao、Thai、Vietnamese、Bengali、Burmese、Finnish、Georgian、Greek、Albanian、Arabic、Armenian、Azerbaijani、Belarusian、Bosnian、Bulgarian、Canadian French、Catalan、Croatian、Czech、Danish、Dutch、Estonian、Filipino、Gujarati、Haitian Creole、Hebrew、Hindi、Hungarian、Icelandic、Indonesian、Javanese、Irish、Kazakh、Khmer、Latin、Latin American Spanish、Brazilian Portuguese、Latvian、Lithuanian、Macedonian、Maltese、Mongolian (Cyrillic)、Montenegrin、Norwegian、Persian、Romanian、Serbian (Cyrillic letters)、Serbian (Latin letters)、Sinhala、Slovak、Slovenian、Swahili、Tamil、Telugu、Oriya、Kannada、Punjabi、Marathi、Malayalam、Uzbek、Urdu、Amharic、Uyghur、Cantonese、Yiddish、Tigrinya、Turkmen (Latin letters)、Turkmen (Cyrillic letters)、Any Language

ParametersTypeDescription
*fromLangStringSource language, source language cannot be the same as target language, see supported languages
*toLangStringTarget language, target language cannot be the same as the source language, see supported languages
*modelStringAvailable models: gpt-4o-mini | gpt-4o | o3-mini | gemini-2.0-flash | gemini-pro | claude-haiku | claude-3.7-sonnet | deepseek-v3 | deepseek-r1
*filebinaryFiles to be Translated,Supported file types: .PDF .DOCX .XLSX .PPTX .EPUB .PO .SRT .TXT .HTML .ZIP .XML .XLF .GO .JPG .JPEG .PNG .MD .ODT .ODS .ODP .CSV .TSV .YAML .PHP .AI
shouldTranslateImageStringValid values: "true" or "false". Whether to translate images in PDF documents, default value is false
glossaryStringTerminology glossary name used for translation
previewStringValid values: "true" or "false". Generate a preview of the document translation by paying 2 credits

Response

ParametersTypeDescription
taskIdStringID of the created task

Query translation

Query translation tasks, including task status, translated file links

curl
1curl -X POST 'https://otranslator.com/api/v1/translation/query' \
2--header 'Authorization: [yourSecretKey]' \
3--header 'Content-Type: application/json' \
4--data  '{ "taskId": "[created taskId]" }'

Request Parameters

ParametersTypeDescription
*taskIdStringTranslation Task ID

Response

ParametersTypeDescription
statusString'Waiting' | 'Processing' | 'Completed' | 'Terminated'
progressinteger0~100, Translation Task Progress
translatedFileUrlStringTranslation file download link, only valid when translation is completed (status = 'Completed')
translatedBilingualFileUrlStringDownload link for bilingual file translation, only valid when translation is completed (status ='Completed')
usedCreditsintegerCredits Used for Translation
tokenCountintegerNumber of tokens corresponding to the text in the document
glossaryString[]Name of terminology glossary used in the document

Delete translation

Delete translation tasks and related documents. Translation tasks created by API will be automatically deleted after 7 days.

curl
1curl -X POST 'https://otranslator.com/api/v1/translation/delete' \
2--header 'Authorization: [yourSecretKey]' \
3--header 'Content-Type: application/json' \
4--data  '{ "taskId": "[created taskId]" }'

Request Parameters

ParametersTypeDescription
*taskIdStringTranslation Task ID to be Deleted