异步任务

取消任务

取消仍在排队并且支持取消的异步任务

DELETE
/v1/tasks/{id}

概览

DELETE /v1/tasks/{id} 可以取消尚未开始运行、并且支持取消的任务。ID 来自创建响应或 poll_url。

支持范围

支持取消的排队中 Seedance 任务包括 seedance-2.0、seedance-2.0-fast 和 seedance-2.5,具体取决于任务是否支持取消。已开始运行或已进入终态的任务不能取消。已取消的任务不计费。公开任务记录保留期间仍可查询状态。

通过 Volc 兼容的 Seedance 端点创建的任务,请见取消任务(Volc 兼容)。

路径参数

idstringpath必填

由 create 请求返回或包含在 poll_url 中的异步任务 ID。

响应

idstring

TokenLab 任务 ID。

task_idstring

同一个任务 ID 的兼容字段名。

poll_urlstring

任务的状态地址,取消后仍然有效。用 id 调用 GET /v1/tasks/{id} 查询。

statusstring

任务状态。成功取消的任务会以 failed 返回,并带有 cancelled: true,以兼容现有状态值。

cancelledboolean

任务在执行前被取消时为 true。

cancellation_statusstring

取消标记。取消成功时值为 cancelled。

errorstring

取消原因或任务失败信息。

错误行为

HTTP错误码含义
400missing_task_id、invalid_task_id任务 ID 缺失或不是有效的任务 ID
400unsupported_task_cancel该任务类型或模型不支持取消
403task_not_owned任务不属于此 API 密钥所在的工作区
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 Key。

位置: header

路径参数

id*string

由 id / task_id 返回或嵌入在 poll_url 中的异步任务 ID

响应

application/json

application/json

application/json

application/json

application/json

application/json

application/json