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 кредити для створення попереднього перегляду перекладу документа	-
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 зворотного виклику при оновленні статусу, вміст зворотного виклику включає: {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.