API reference

ジョブの状態を取得

生成ジョブの進行状況と、結果を取得できるかどうかを確認します。

GET
/v1/creative/jobs/{id}/status

認証

Authorizationstringrequired
Bearer YOUR_API_KEY を指定します。x-api-key による認証も使用できますが、両方を同時には送信しません。キーはサーバー側で保管してください。

Bearer YOUR_API_KEY を指定します。x-api-key による認証も使用できますが、両方を同時には送信しません。キーはサーバー側で保管してください。

パスパラメーター

idstringrequired
生成時に受け取ったジョブ ID。同じワークスペースのジョブを指定します。例:job_7513b52d-3669-4ffe-b317-8b02000715eb。

生成時に受け取ったジョブ ID。同じワークスペースのジョブを指定します。例:job_7513b52d-3669-4ffe-b317-8b02000715eb。

レスポンス

進行状況と次の操作。terminal が true なら状態確認を終了し、result_ready が true のとき result_url を取得します。

data.request_idstring
この生成または HTTP 要求を追跡する ID。HTTP の相関 ID とジョブ ID は別に記録します。

この生成または HTTP 要求を追跡する ID。HTTP の相関 ID とジョブ ID は別に記録します。

data.job_idstring
状態・結果・イベントを取得する生成ジョブの ID。

状態・結果・イベントを取得する生成ジョブの ID。

data.statusstring
進行状況の大文字表記。orchestor_status に対応し、COMPLETED、FAILED、CANCELED は終端状態です。 値:IN_QUEUE、IN_PROGRESS、COMPLETED、FAILED、CANCELED。

進行状況の大文字表記。orchestor_status に対応し、COMPLETED、FAILED、CANCELED は終端状態です。 値:IN_QUEUE、IN_PROGRESS、COMPLETED、FAILED、CANCELED。

data.orchestor_statusstring
共通ジョブの小文字の状態。status の大文字表記と同じ進行状況を表します。 値:queued、processing、completed、failed、canceled。

共通ジョブの小文字の状態。status の大文字表記と同じ進行状況を表します。 値:queued、processing、completed、failed、canceled。

data.status_urlstring
このジョブの状態を GET で確認する URL。

このジョブの状態を GET で確認する URL。

data.result_urlstring
完了後の成果物を GET で取得する URL。

完了後の成果物を GET で取得する URL。

data.events_urlstring
ジョブの状態遷移と配信履歴を取得する URL。

ジョブの状態遷移と配信履歴を取得する URL。

data.cancel_urlstring | null
生成開始前に取り消すための POST 先。取り消せない場合は null。

生成開始前に取り消すための POST 先。取り消せない場合は null。

data.cancelableboolean
現在このジョブを取り消せるかどうか。

現在このジョブを取り消せるかどうか。

data.next_actionstring
次に必要な操作。値に従って入力修正、待機、状態確認、結果取得などを行います。 値:poll_status、fetch_result、inspect_events。

次に必要な操作。値に従って入力修正、待機、状態確認、結果取得などを行います。 値:poll_status、fetch_result、inspect_events。

data.next_poll_after_secondsinteger | null
次の状態取得まで待つ秒数。終端状態では null。

次の状態取得まで待つ秒数。終端状態では null。

data.recommended_poll_interval_secondsinteger | null
継続して状態を取得する場合の推奨間隔。単位は秒。

継続して状態を取得する場合の推奨間隔。単位は秒。

data.retry_after_secondsinteger | null
同じ要求を再試行するまで待つ秒数。再試行不要なら null。

同じ要求を再試行するまで待つ秒数。再試行不要なら null。

data.result_readyboolean
成果物を result_url から取得できるかどうか。

成果物を result_url から取得できるかどうか。

data.terminalboolean
成功・失敗・取消のいずれかで処理が終了したかどうか。

成功・失敗・取消のいずれかで処理が終了したかどうか。

data.queueobject
ジョブの待機順、再開予定、実行環境の状態。

ジョブの待機順、再開予定、実行環境の状態。

data.queue_positioninteger | null
待機列の位置。位置が確定しない場合は null。

待機列の位置。位置が確定しない場合は null。

data.logs_availableboolean
ジョブのイベント履歴を参照できるかどうか。

ジョブのイベント履歴を参照できるかどうか。

data.jobobject
生成ジョブの入力、状態、時刻、結果をまとめた情報。

生成ジョブの入力、状態、時刻、結果をまとめた情報。

その他の応答は 400、403、429、500、502、503 です。429 は retry-after に従って再試行してください。

terminal が true でも、成功とは限りません。result_ready が true のとき、result_url から成果物を取得します。

関連ページ