API リファレンス

待機中のジョブを取り消す

生成開始前のジョブを取り消します。成功時は取消結果と更新済みのジョブを返します。

POST
/v1/creative/jobs/{id}/cancel

認証

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。

レスポンス

取消結果と更新済みのジョブ。canceled が true なら生成開始前の取消が完了しています。

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

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

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

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

data.statusstring
対象リソースの現在の処理状態。 値:CANCELED。

対象リソースの現在の処理状態。 値:CANCELED。

data.canceledboolean
生成開始前の取消が完了したかどうか。

生成開始前の取消が完了したかどうか。

data.idempotency_hitboolean
同じ冪等性キーと入力に対応する既存ジョブを返したかどうか。

同じ冪等性キーと入力に対応する既存ジョブを返したかどうか。

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

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

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

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

data.cancellationobject
取消の対応可否と実行結果。

取消の対応可否と実行結果。

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

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

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

要求本文は不要です。状態取得時の cancelable が true でも、取消までに生成が始まる場合があります。取消の応答を確認してください。

関連ページ