コンテンツにスキップ

翻訳ジョブを作成する

POST /api/v1/jobs
Idempotency-Key: 7a40d1c7-6ee8-4cc1-b74b-132792bd402f
Content-Type: application/json
フィールドタイプ必須デフォルト説明
document_id文字列✅—確認済みドキュメントの ID
target_lang文字列✅—ターゲット言語コード
source_lang文字列—自動検出ソース言語コード
engine文字列—xr-397b翻訳設定IDについては、翻訳設定を参照してください。
output_mode文字列—bilingualsingle または bilingual
glossary_id文字列——このアカウントの用語集ID。用語集は支払い済みのアカウント(少なくとも1回の成功した支払いがある)に対して作成されます。未払いのアカウントから送信された場合、403 が返されます。
include_imagesブール値—falseまた、ドキュメントの画像内のテキストも翻訳してください。
context_translationブール値—falseコンテキスト強化を有効にする
style_preset文字列——スタイルプリセット

作成されたジョブはキューに入ります。各アカウントは一度に最大5つのファイルを処理でき、それ以上のジョブも引き続き作成され、先に処理が完了した順に自動的にキューから実行されます。ジョブが待機している間、そのstage_messageにはどれだけのジョブが待ち行列の先にあるかが表示されます。

ジョブが開始される前に、残高がしきい値と照合されます:PDF では「ページ数 × 2 クレジット」を超える残高が必要です;他の形式は原文テキストの長さに基づき、最低でも 2 クレジットです。残高でファイルを開始できない場合、そのジョブは status=failed および quota_exceeded=true で終了し、料金は請求されず、他のジョブには影響しません。ジョブが完了すると、実際の使用量が課金されます;費用が残高を超えた場合、残高はマイナスになり、後から入金されたクレジットがまず債務を返済し、残高がマイナスの間は新しいジョブを開始できないため、チャージしてください。 クレジットと使用量 をご参照ください。

Terminal window
curl --fail-with-body -X POST https://omnidoc.top/api/v1/jobs \
-H "X-API-Key: $OMNIDOC_API_KEY" \
-H "Idempotency-Key: 7a40d1c7-6ee8-4cc1-b74b-132792bd402f" \
-H "Content-Type: application/json" \
-d '{"document_id":"4q8mx2q9z1k7p6ra","target_lang":"en"}'

レスポンス 201(サーバーの stage_message は中国語です):

{
"id": "q3f8s6c2a9m1k4tx",
"document_id": "4q8mx2q9z1k7p6ra",
"source_lang": null,
"target_lang": "en",
"engine": "xr-397b",
"status": "pending",
"stage": "queued",
"stage_progress": 0,
"stage_message": "排队中",
"time_cost": 0,
"error_msg": null,
"quota_exceeded": false,
"queue_position": null,
"created_at": "2026-10-01T12:01:00Z",
"updated_at": "2026-10-01T12:01:00Z"
}
ステータス原因
403キーが選択された設定を許可していないか、未払いのアカウントから glossary_id が送信されました。
404ドキュメントまたは用語集が存在しない、削除された、または別のアカウントに属しています
415ファイル形式は変換できません
422ファイルが空であるか、翻訳可能なテキストがないか、またはパラメータが無効です。
429リクエストが多すぎるか、キューが一杯です。Retry-After 後に再試行してください。

Idempotency-Keyは任意ですが、すべての提出物に対して推奨されます。キーは1~128文字の可視ASCII文字で構成され、同一の資格情報については無期限に有効です:

  • 同じキー、同じ本体:元のジョブ(失敗したジョブを含む)が返されます。二重に作成されたり請求されたりすることはありません。
  • 同一キー、異なるボディ: 409 (idempotency_request_conflict)。
  • 元のジョブが削除されました: 410 (idempotency_job_gone)。

新しい提出ごとに新しい UUID を使用し、同じ提出を再試行する場合にのみ元のキーを再利用してください。