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 | - | Статус: 'Инициализация' | 'Ожидание' | 'Обработка' | 'Завершено' | 'Прервано' | 'Отменено' | - |
| progress | Number | - | прогресс, 0~100 | - |
| errorMsg | String | - | Сообщение об ошибке | - |
| fileTitle | String | - | Имя оригинального файла | - |
| fileUrl | String | - | Адрес загрузки оригинального файла | - |
| translatedFileUrl | String | - | Адрес для загрузки перевода | - |
| translatedBilingualFileUrl | String | - |
| - |
| translatedEditableFileUrl | String | - | Адрес загрузки редактируемого файла перевода. Возвращается только при создании редактируемого результата для соответствующего типа файла. | - |
| tokenCount | Integer | - |
| - |
| wordNums | Integer | - | Статистика слов документа. Может быть пустым для различных типов файлов. | - |
| price | Integer | - | Общее количество Credits, необходимых для перевода | - |
| usedCredits | Integer | - | Количество кредитов, использованных задачей перевода | - |
| 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.