文档目录

翻译任务 API

查询翻译任务

POST/v1/translation/query

查询翻译任务的状态和详情。

完整地址
https://otranslator.com/api/v1/translation/query
认证
需要在 Authorization 请求头中传入 API Key
Content-Type
application/json
错误格式
{ "error": "Invalid API key." }

注意事项

建议在任务状态为 Waiting 或 Processing 时轮询该接口,状态进入 Completed、Terminated 或 Cancelled 后停止轮询。

下载链接为临时访问地址,请在业务侧按需保存文件或重新查询获取。

示例

curl
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}'

请求参数

参数类型默认描述示例
*taskIdString-

翻译任务ID

-

响应

参数类型默认描述示例
taskIdString-

任务ID

-
modelString-

翻译时使用的模型

-
fromLangString-

原语言

-
toLangString-

目标语言

-
statusString-

状态: '初始化' | '等待中' | '处理中' | '已完成' | '已终止' | '已取消'

-
progressNumber-

进度,0~100

-
errorMsgString-

错误信息

-
fileTitleString-

原文件名

-
fileUrlString-

原文件下载地址

-
translatedFileUrlString-

译文的下载地址

-
translatedBilingualFileUrlString-
  • 双语译文的下载地址,仅支持 PDF、DOCX、PPTX、XLSX、EPUB、CSV、SRT、TXT、HTML、ODF
  • 当文件过大或翻译出错时,将不会生成双语译文
-
translatedEditableFileUrlString-

可编辑译文文件下载地址。仅在对应文件类型生成可编辑结果时返回。

-
tokenCountInteger-
  • 文档中需要翻译文本的Tokens
  • PDF中的图片翻译按每页1200 Tokens 计算
-
wordNumsInteger-

文档统计词数。不同文件类型可能为空。

-
priceInteger-

整体翻译所需的Credits数

-
usedCreditsInteger-

翻译任务已使用的Credits数

-
glossaryString[]-

翻译任务使用的术语表名称

-
shouldTranslateImageBoolean-

是否翻译文档中的图片

-
forceOCRBoolean-

是否强制使用 OCR 识别文档内容

-
createdAtDateTime-

翻译任务的创建时间

-
updatedAtDateTime-

翻译任务的更新时间

-

常见错误

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.

翻译任务 API
创建翻译任务
翻译任务 API
删除翻译任务