タスクをキャンセル

概要Copy Anchor Link

DELETE /v1/tasks/{id} を使って、まだ実行開始していない非同期タスクをキャンセルします。create レスポンスのタスク ID、または poll_url に含まれる同じ ID を使用してください。

対応タスクCopy Anchor Link

キャンセル対応のキュー中 Seedance タスクでは seedance-1.5-pro、seedance-2.0、seedance-2.0-fast、seedance-2.5 を利用できます。実行中または終端状態のタスクはキャンセルできません。公開タスク記録が保持されている間はステータスを照会できます。

パスパラメーターCopy Anchor Link

レスポンスCopy Anchor Link

エラー動作Copy Anchor Link

400 unsupported_task_cancel は、タスク種別、プロバイダー、またはモデルがキャンセルに対応していないことを示します。409 task_not_cancellable は、タスクがすでに処理中、終端状態、またはキャンセル不能であることを示します。403 は API key がそのタスクにアクセスできないことを示します。

例Copy Anchor Link

curl -X DELETE "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer sk-your-api-key"

{
  "id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "task_id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "poll_url": "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "status": "failed",
  "cancelled": true,
  "cancellation_status": "cancelled",
  "error": "Task cancelled before execution"
}

{  "id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "task_id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "poll_url": "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "status": "failed",  "cancelled": true,  "cancellation_status": "cancelled",  "error": "Task cancelled before execution"}