ジョブのステータス
GET /api/v1/jobs/{job_id}クエリはステータスを読み取るだけで、クレジットは消費しません。
curl https://omnidoc.top/api/v1/jobs/q3f8s6c2a9m1k4tx \ -H "X-API-Key: $OMNIDOC_API_KEY"ライフサイクル状態
Section titled “ライフサイクル状態”status | 意味 |
|---|---|
pending | 作成済み、キューで待機中 |
processing | 処理中 |
completed | 完了しました。結果を確認できます。 |
failed | 失敗またはキャンセルされました。error_msg を参照してください。 |
statusは、ジョブが終了したかどうかを示します。
stage | 意味 |
|---|---|
queued | キュー内 |
accepted / preflight | 承認済み、準備中 |
translating | 翻訳中 |
writing_artifacts / finalizing | 結果の生成と登録 |
completed / failed | 終了しました |
stage_progressは0から100への進行状況を表示するもので、請求には使用されません。キューイング中は、queue_positionに次のジョブ数が表示される場合と、nullが表示される場合があります。
リストとキャンセル
Section titled “リストとキャンセル”GET /api/v1/jobs?limit=20&before=2026-10-01T12:00:00ZPOST /api/v1/jobs/{job_id}/cancelキャンセルはベストエフォートであり、既に終了したジョブは 409 を返します。キャンセルされたジョブには料金が発生せず、クレジット記録で確認できます。
結果を取得する
Section titled “結果を取得する”ジョブの完了後:
GET /api/v1/artifacts?job_id={job_id}ジョブがまだ実行中の間、結果リストは空です。