TokenLab

非同步任務

取消任務

當模型支援取消功能時,取消已排隊的非同步任務

DELETE
/v1/tasks/{id}

概覽

使用 DELETE /v1/tasks/{id} 來取消尚未開始執行的非同步任務。請使用建立任務時的回應或回傳的 poll_url 中所包含的相同任務 ID。

支援的任務

當任務支援取消功能時,使用 seedance-2.0、seedance-2.0-fast 或 seedance-2.5 的已排隊 Seedance 任務可進行取消。已在執行中或處於終止狀態的任務無法取消。已取消的任務不會計費。在保留公開任務記錄期間,任務狀態仍可供查詢。

若要取消透過 Volc 相容 Seedance 端點建立的任務,請參閱 取消任務 (Volc 相容)。

路徑參數

idstringpath必填

由建立請求回傳或嵌入在 poll_url 中的非同步任務 ID。

回應

idstring

標準非同步任務識別碼。

task_idstring

非同步任務識別碼別名。

poll_urlstring

任務的狀態 URL。取消後該 URL 仍然有效。請使用 id 對 GET /v1/tasks/{id} 進行輪詢。

statusstring

任務狀態。為了與現有狀態值相容,成功取消的任務將回傳為 failed 並帶有 cancelled: true。

cancelledboolean

當任務在執行前被取消時為 true。

cancellation_statusstring

取消標記。當取消成功時,該值為 cancelled。

errorstring

取消原因或任務失敗訊息。

錯誤行為

HTTPCode含義
400missing_task_id, invalid_task_id缺少任務 ID 或任務 ID 無效
400unsupported_task_cancel任務類型或模型不支援取消
403task_not_owned該任務不屬於此 API key 的工作區
404async_task_not_found任務已過期或無法取得
409task_not_cancellable任務已在處理中、已完成或無法再取消。current_status 會顯示其狀態
503async_task_owner_unavailable目前無法讀取任務。請重試

範例

請求

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

回應

Response
{
  "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
AuthorizationBearer <token>

API Key 驗證。請在 Dashboard > API > API Keys 建立或管理 API 金鑰。

位置: header

路徑參數

id*string

由 id / task_id 回傳,或嵌入於 poll_url 中的非同步任務 ID

回應

application/json

application/json

application/json

application/json

application/json

application/json

application/json