异步任务
取消任务
取消仍在排队并且支持取消的异步任务
概览
DELETE /v1/tasks/{id} 可以取消尚未开始运行、并且支持取消的任务。ID 来自创建响应或 poll_url。
支持范围
支持取消的排队中 Seedance 任务包括 seedance-1.5-pro、seedance-2.0、seedance-2.0-fast 和 seedance-2.5，具体取决于任务是否支持取消。已开始运行或已进入终态的任务不能取消。公开任务记录保留期间仍可查询状态。
路径参数
idstringpath必填
由 create 请求返回或包含在 poll_url 中的异步任务 ID。
响应
idstring
TokenLab 任务 ID。
task_idstring
同一个任务 ID 的兼容字段名。
poll_urlstring
任务状态查询地址，取消后仍然有效。
statusstring
任务状态。成功取消的任务会以 failed 返回，并带有 cancelled: true，以兼容现有状态值。
cancelledboolean
任务在执行前被取消时为 true。
cancellation_statusstring
取消标记。取消成功时值为 cancelled。
errorstring
取消原因或任务失败信息。
错误行为
400 unsupported_task_cancel 表示这个任务不支持取消。409 task_not_cancellable 表示任务已经开始、已经结束或无法再取消。403 表示当前 API 密钥无权访问。
示例
请求
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 AuthorizationBearer <token>
API Key 身份验证。在 Dashboard > API > API Keys 中创建或管理 API Key。
位置: header
路径参数
id*string
由 id / task_id 返回或嵌入在 poll_url 中的异步任务 ID
响应
application/json
application/json
application/json
application/json
application/json
application/json
application/json