API reference
待機中のジョブを取り消す
生成開始前のジョブを取り消します。成功時は取消結果と更新済みのジョブを返します。
POST
/v1/creative/jobs/{id}/cancel
認証
AuthorizationstringrequiredBearer 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 でも、取消までに生成が始まる場合があります。取消の応答を確認してください。
curl --request POST 'https://api.orchestor.io/v1/creative/jobs/job_7513b52d-3669-4ffe-b317-8b02000715eb/cancel' \
--header "Authorization: Bearer $ORCHESTOR_API_KEY"Python の例には requests が必要です(python3 -m pip install requests)。
{
"data": {
"request_id": "job_7513b52d-3669-4ffe-b317-8b02000715eb",
"job_id": "job_7513b52d-3669-4ffe-b317-8b02000715eb",
"status": "CANCELED",
"canceled": true,
"idempotency_hit": false,
"status_url": "https://api.orchestor.io/v1/creative/jobs/job_7513b52d-3669-4ffe-b317-8b02000715eb/status",
"result_url": "https://api.orchestor.io/v1/creative/jobs/job_7513b52d-3669-4ffe-b317-8b02000715eb/result",
"cancellation": {
"supported": true,
"requested": true,
"message": "生成開始前に取り消しました。"
},
"job": {
"id": "job_7513b52d-3669-4ffe-b317-8b02000715eb",
"type": "image_generation",
"status": "canceled",
"model": "gpt-image-2",
"idempotency_key": "9816bc88-9791-43a1-86c2-876dc7c544e8",
"communication_mode": "async",
"created_at": "2026-11-06T00:00:00Z",
"updated_at": "2026-11-06T00:00:00Z",
"started_at": null,
"completed_at": null,
"canceled_at": "2026-11-06T00:00:00Z",
"result": null,
"error": null,
"usage_summary": null,
"webhook_delivery": null,
"input": {
"model": "gpt-image-2",
"prompt": "白い背景の上に置いた青い陶器の花瓶",
"aspect_ratio": "1:1",
"mode": "async"
}
}
}
}