API задач перевода

Создать задачу перевода

POST/v1/translation/create

Создайте новую задачу перевода для перевода документа/файла.

Полный адрес: https://otranslator.com/api/v1/translation/create
Аутентификация: Необходимо передать API Key в заголовке запроса Authorization
Content-Type: multipart/form-data
Ошибочный формат: { "error": "Invalid API key." }

Меры предосторожности

Создание задачи немедленно попадает в очередь ожидания и возвращает taskId. Впоследствии можно получить прогресс, стоимость и ссылку для скачивания через интерфейс запроса задачи.

Баланс счёта должен составлять минимум 2 credits для создания задачи. Когда preview равен true, генерируется только предварительный просмотр и оплачиваются кредиты за предварительный просмотр.

Параметр glossary сопоставляется по имени глоссария, можно многократно передавать одноименные поля для указания нескольких глоссариев.

Пример

curl

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

Параметры запроса

Параметры	Тип	По умолчанию	Описание	Пример
*file	binary	-	Файл, который необходимо перевести Поддерживаемые типы файлов: запрос	bitcoin.pdf
*fromLang	String	-	Исходный язык, исходный язык не может совпадать с целевым языком Поддерживаемые языки: запрос	English
*toLang	String	-	Целевой язык, целевой язык не может совпадать с исходным языком Поддерживаемые языки: запрос	Simplified Chinese
model	String	-	AI-модель для перевода Поддерживаемые модели: запрос	-
fileDescription	String	-	Описание документа: повышение качества перевода путём предоставления дополнительной информации, например, добавление справочных сведений о документе и прочих требований к переводу	-
glossary	String	-	Название глоссария, используемого при переводе	-
preview	Boolean	false	Генерировать только предварительный просмотр. При генерации только предварительного просмотра заплатите 2 credits для создания предварительного просмотра перевода документа	-
shouldTranslateImage	Boolean	false	Переводить ли изображения в документе Поддерживает только PDF / DOCX / PPTX / EPUB / ODS / ODT / ODF	-
forceOCR	Boolean	false	Принудительно использовать OCR для распознавания содержимого документа. При включении также активируется перевод изображений.	-
shouldTranslateFileName	Boolean	true	Переводить ли имена файлов	-
strictSourceLanguageCheck	Boolean	false	Переводить только текст, распознанный как исходный язык. При включении содержимое не на исходном языке будет фильтроваться более строго, а при расчете стоимости будет использоваться более строгий коэффициент.	-
outputFormat	String	-	Формат вывода. При передаче MD будет предпринята попытка сгенерировать перевод в Markdown.	MD
bilingualMode	String	Horizontal	Направление расположения двуязычного файла. Horizontal означает расположение слева направо, Vertical означает расположение сверху вниз.	Horizontal
password	String	-	Пароль для открытия PDF-файла	-
ignoreComments	Boolean	false	Игнорировать ли примечания в DOCX, PPTX и XLSX	-
ignoreNotes	Boolean	false	Игнорировать ли заметки в PPTX	-
ignoreHeadersAndFooters	Boolean	false	Игнорировать ли верхние и нижние колонтитулы в DOCX	-
ignoreHidden	Boolean	false	Игнорировать ли скрытые слайды в PPTX	-
ignoreMasters	Boolean	false	Игнорировать ли текст образца слайдов в PPTX	-
ignoreSheetNames	Boolean	false	Не переводить ли названия листов XLSX	-
extractTextRegExpPattern	String	-	Переводить только содержимое, соответствующее регулярному выражению, и заменять его переводом Поддерживает только txmsg	-
extractTextRegExpFlags	String	-	Флаги регулярных выражений: g, s, m, u, y Поддерживается только txmsg	-
allowFlip	Boolean	true	Разрешить отзеркаливание макета страницы для языков с письмом справа налево. При значении false отзеркаливание изображений также отключается.	-
allowFlipImage	Boolean	true	Разрешить отзеркаливание содержимого изображений для языков с письмом справа налево.	-
webhookUrl	String	-	URL callback при обновлении статуса, содержимое callback включает: {taskId, progress, status}	-

Ответ

Параметры	Тип	По умолчанию	Описание	Пример
taskId	String	-	ID задачи	-

Распространенные ошибки

401 Missing API key.

The Authorization request header is required.

401 Invalid API key.

The API key does not exist, has been deleted, or is no longer valid.

402 Insufficient credits balance.

The account does not have enough credits to create the task.

400 Missing required parameter: fromLang.

Provide fromLang using a language returned by /api/v1/languages.

400 Missing required parameter: toLang.

Provide toLang using a language returned by /api/v1/languages.

400 Invalid fromLang: [language]. Use a language returned by /api/v1/languages.

The provided source language is not supported.

400 Invalid toLang: [language]. Use a language returned by /api/v1/languages.

The provided target language is not supported.

400 Missing required file upload: file.

Upload the source document in the file form field.

404 Glossary "[name]" not found.

The specified glossary does not exist or does not belong to the current API account.