非同步任務
取消任務
在供應商和模型支援時取消排隊中的非同步任務
概覽
使用 DELETE /v1/tasks/{id} 取消尚未開始執行的非同步任務。請使用 create 回應中的任務 ID,或 poll_url 中帶有的同一 ID。
支援範圍
支援取消的排隊中 Seedance 任務包括 seedance-1.5-pro、seedance-2.0、seedance-2.0-fast 與 seedance-2.5,實際取決於任務是否支援取消。已開始執行或已進入終態的任務不能取消。公開任務記錄保留期間仍可查詢狀態。
路徑參數
由 create 請求返回或包含在 poll_url 中的非同步任務 ID。
回應
標準非同步任務識別碼。
非同步任務識別碼別名。
任務的首選輪詢 URL。取消後仍然有效。
任務狀態。成功取消的任務會以 failed 返回,並帶有 cancelled: true,以相容既有狀態值。
任務在執行前被取消時為 true。
取消標記。取消成功時值為 cancelled。
取消原因或任務失敗訊息。
錯誤行為
400 unsupported_task_cancel 表示任務類型、供應商或模型不支援取消。409 task_not_cancellable 表示任務已開始處理、已終態或不再可取消。403 表示目前 API key 無權存取該任務。
範例
請求
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"}授權
BearerAuth API Key 驗證。請在 Dashboard > API > API Keys 建立或管理 API 金鑰。
位置: header
路徑參數
由 id / task_id 回傳,或嵌入於 poll_url 中的非同步任務 ID
回應
application/json
application/json
application/json
application/json
application/json
application/json
application/json