翻訳タスクAPI
翻訳タスクの照会
翻訳タスクのステータスと詳細を照会します。
- 完全な住所
- https://otranslator.com/api/v1/translation/query
- 認証
- Authorizationリクエストヘッダーに API Key を渡す必要があります
- 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.