API завдання перекладу
Запит завдань перекладу
Запитати статус та деталі завдання перекладу.
- Повна адреса
- https://otranslator.com/api/v1/translation/query
- Аутентифікація
- Потрібно передати API Key у заголовку запиту Authorization
- Content-Type
- application/json
- Неправильний формат
- { "error": "Invalid API key." }
Застереження
Рекомендується опитувати цей інтерфейс, коли статус завдання Waiting або Processing, і зупинити опитування після переходу статусу в Completed, Terminated або Cancelled.
Посилання для завантаження є тимчасовою адресою доступу, збережіть файл на своїй стороні за потреби або повторно виконайте запит для отримання.
Приклад
1curl -X POST 'https://otranslator.com/api/v1/translation/query' \
2--header 'Authorization: [yourSecretKey]' \
3--header 'Content-Type: application/json' \
4--data '{
5 "taskId": "[string]"
6}'Параметри запиту
| Параметри | Тип | За замовчуванням | Опис | Приклад |
|---|---|---|---|---|
| *taskId | String | - | ID завдання перекладу | - |
Відповідь
| Параметри | Тип | За замовчуванням | Опис | Приклад |
|---|---|---|---|---|
| taskId | String | - | ID завдання | - |
| model | String | - | Модель, використана для перекладу | - |
| fromLang | String | - | Вихідна мова | - |
| toLang | String | - | Цільова мова | - |
| status | String | - | Статус: 'Init' | 'Waiting' | 'Processing' | 'Completed' | 'Terminated' | 'Cancelled' | - |
| progress | Number | - | прогрес, 0~100 | - |
| errorMsg | String | - | Повідомлення про помилку | - |
| fileTitle | String | - | Назва оригінального файлу | - |
| fileUrl | String | - | Адреса завантаження оригінального файлу | - |
| translatedFileUrl | String | - | Адреса для завантаження перекладу | - |
| translatedBilingualFileUrl | String | - |
| - |
| translatedEditableFileUrl | String | - | Адреса завантаження редагованого файлу перекладу. Повертається лише за наявності редагованого результату для відповідного типу файлу. | - |
| tokenCount | Integer | - |
| - |
| wordNums | Integer | - | Статистика кількості слів документа. Може бути порожньою для різних типів файлів. | - |
| price | Integer | - | Загальна кількість кредитів, необхідних для перекладу | - |
| usedCredits | Integer | - | Кількість Credits, використаних завданням перекладу | - |
| glossary | String[] | - | Назва глосарію, що використовується завданням перекладу | - |
| shouldTranslateImage | Boolean | - | Чи перекладати зображення в документі | - |
| forceOCR | Boolean | - | Чи примусово використовувати OCR для розпізнавання вмісту документа | - |
| createdAt | DateTime | - | Час створення завдання перекладу | - |
| updatedAt | DateTime | - | Час оновлення завдання перекладу | - |
Поширені помилки
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.
400 Missing required parameter: taskId.
Provide the taskId returned by the create translation task API.
404 Task not found.
The task does not exist, has been deleted, does not belong to the current API account, or was not created through the API.