概覽
使用DELETE /v1/tasks/{id} 取消尚未開始執行的非同步任務。請使用 create 回應中的任務 ID，或 poll_url 中帶有的同一 ID。
支援範圍
目前僅在該任務實際使用的提供商支援取消時，支援取消排隊中的 Seedance 影片任務。支援模型包括seedance-1.5-pro、seedance-2.0 和 seedance-2.0-fast。已進入 processing/running 的任務不能取消。已完成、失敗、過期或不支援取消的任務仍可用於狀態查詢和計費核對。
路徑參數
string
必填
由 create 請求返回或包含在
poll_url 中的非同步任務 ID。回應
string
標準非同步任務識別碼。
string
非同步任務識別碼別名。
string
任務的首選輪詢 URL。取消後仍然有效。
string
任務狀態。成功取消的任務會以
failed 返回，並帶有 cancelled: true，以相容既有狀態值。boolean
任務在執行前被取消時為
true。string
取消標記。取消成功時值為
cancelled。string
取消原因或任務失敗訊息。
錯誤行為
400 unsupported_task_cancel 表示任務類型、供應商或模型不支援取消。409 task_not_cancellable 表示任務已開始處理、已終態或不再可取消。403 表示目前 API key 無權存取該任務。
範例
Response