--- title: "Cancel an agent task" method: POST path: "/tasks/{task_id}/cancel" tags: ["Tasks"] --- # Cancel an agent task `POST /tasks/{task_id}/cancel` Cancels a model task with the given ID. Only tasks created with the `background` parameter set to `true` can be cancelled. [Learn more](https://docs.linxueyuan.online/guides/background). ## Path parameters - `task_id` string, required — The ID of the task to cancel ## Response `200` Successful Response - TaskObject — The task object returned in JSON-RPC result. - `object` 'task', required — 固定为 task。 - `id` string, required — 任务 ID。 - `session_id` string, required — 会话 ID。 - `user_id` string, required — 用户 ID。 - `status` 'created' | 'queued' | 'working' | 'input-required' | 'paused' | 'completed' | 'canceled' | 'expired' | 'failed', required — 任务生命周期状态。 CREATED：任务已创建但尚未开始。 QUEUED：任务已排队，等待处理。 WORKING：任务正在处理中。 INPUT_REQUIRED：任务需要额外输入以继续。 PAUSED：任务已暂停，需恢复后继续。 COMPLETED：任务已成功完成。 CANCELED：任务已取消，不会继续处理。 EXPIRED：任务已过期，不会继续处理。 FAILED：任务处理失败，不会重试。 常见情况： 1. CREATED -> WORKING -> COMPLETED|FAILED|CANCELED|EXPIRED 2. CREATED -> WORKING -> INPUT_REQUIRED -> WORKING -> COMPLETED|FAILED|CANCELED|EXPIRED 3. CREATED -> WORKING -> PAUSED -> WORKING -> COMPLETED|FAILED|CANCELED|EXPIRED 4. CREATED -> QUEUED -> WORKING -> COMPLETED|FAILED|CANCELED|EXPIRED 5. CREATED -> QUEUED -> WORKING -> INPUT_REQUIRED -> WORKING -> COMPLETED|FAILED|CANCELED|EXPIRED 6. CREATED -> QUEUED -> WORKING -> PAUSED -> WORKING -> COMPLETED|FAILED|CANCELED|EXPIRED 取消情况： 1. CREATED -> CANCELED 2. CREATED -> WORKING -> CANCELED 3. CREATED -> QUEUED -> CANCELED 4. CREATED -> QUEUED -> WORKING -> CANCELED 5. CREATED -> QUEUED -> WORKING -> PAUSED -> CANCELED 6. CREATED -> QUEUED -> WORKING -> INPUT_REQUIRED -> CANCELED 过期情况： 1. CREATED -> WORKING -> EXPIRED 2. CREATED -> WORKING -> INPUT_REQUIRED -> EXPIRED 3. CREATED -> WORKING -> PAUSED -> EXPIRED 4. CREATED -> QUEUED -> EXPIRED 5. CREATED -> QUEUED -> WORKING -> EXPIRED 6. CREATED -> QUEUED -> WORKING -> INPUT_REQUIRED -> EXPIRED 7. CREATED -> QUEUED -> WORKING -> PAUSED -> EXPIRED - `created_at` integer, required — 任务创建时间（Unix 秒）。 - `output` OutputItem[], required — 模型/代理生成的输出条目集合（多类型）。 - union — An output item produced by the agent/model. - object - `type` 'reasoning', required — 推理项类型标识。 - `id` string, required — 推理项 ID。 - `summary` TextContentItem[], required — 推理摘要内容（结构化）。 - `type` 'text' | 'input_text' | 'output_text' | 'reasoning_text' | 'summary_text' | 'refusal', required — 文本内容类型。 - `text` string, required — 文本内容。 - `id` integer — 可选的内容引用 ID。 - `tags` string[] — 可选标签，用于标记内容来源或用途（如 "added_by_reference_manager"）。 - `annotations` Annotation[] — 文本注释（如引用、链接、文件路径等），与后端 Annotation 模型一致。 - union - … - `logprobs` LogProb[] — 每个 token 的对数概率信息（可选）。 - `token` string, required - `logprob` number, required - `bytes` integer[], required - `top_logprobs` TopLogProb[], required - … - `content` TextContentItem[] — 推理详细内容（可选）。 - `type` 'text' | 'input_text' | 'output_text' | 'reasoning_text' | 'summary_text' | 'refusal', required — 文本内容类型。 - `text` string, required — 文本内容。 - `id` integer — 可选的内容引用 ID。 - `tags` string[] — 可选标签，用于标记内容来源或用途（如 "added_by_reference_manager"）。 - `annotations` Annotation[] — 文本注释（如引用、链接、文件路径等），与后端 Annotation 模型一致。 - union - … - `logprobs` LogProb[] — 每个 token 的对数概率信息（可选）。 - `token` string, required - `logprob` number, required - `bytes` integer[], required - `top_logprobs` TopLogProb[], required - … - `status` 'in_progress' | 'completed' | 'incomplete' — 状态。 - object - `type` 'message', required — 消息条目类型标识。 - `id` string — 消息 ID。 - `status` 'in_progress' | 'completed' | 'incomplete' — 消息生成状态。 - `role` 'user' | 'assistant' | 'system' | 'developer', required — 消息角色。 - `name` string — 角色名称（可选）。 - `message_content` union, required — 消息内容，字符串或内容项数组，工具协议兼容的 message_content（保留字段）。 - string - ContentItem[] — 内容项数组。 - union — A single content item within a message. - … - `block_list` object[] — 渲染块列表（图表/表格等富媒体）。 - object - `type` 'tool_call', required — 工具调用条目类型标识。 - `id` string — 工具调用条目 ID。 - `status` 'in_progress' | 'completed' | 'incomplete' — 调用状态。 - `call_id` string, required — 工具调用唯一 ID（跨事件关联）。 - `name` string, required — 工具名称。 - `arguments` string, required — 工具调用参数（JSON 字符串）。 - `language` 'json' | 'yaml' | 'python' | 'javascript' — 参数语言标注（可选）。 - object - `type` 'tool_result', required — 工具结果条目类型标识。 - `id` string — 工具结果条目 ID。 - `status` 'in_progress' | 'completed' | 'incomplete' — 结果状态。 - `call_id` string, required — 对应的工具调用 ID。 - `message_content` union, required — 消息内容，字符串或内容项数组，工具协议兼容的 message_content（保留字段）。 - string - ContentItem[] — 内容项数组。 - union — A single content item within a message. - … - `block_list` object[], required — 工具结果的渲染块列表。 - `usage` object — token 用量统计信息。 - `error` JSONRPCError — JSON-RPC error object. - `code` integer, required — 错误码（遵循 JSON-RPC 约定或服务端自定义）。 - `message` string, required — 错误信息。 - `data` union — 自定义错误数据，任意 JSON 值或 null。 - object - string - number - integer - boolean - `input_required` ToolCallItem - `type` 'tool_call', required — 工具调用条目类型标识。 - `id` string — 工具调用条目 ID。 - `status` 'in_progress' | 'completed' | 'incomplete' — 调用状态。 - `call_id` string, required — 工具调用唯一 ID（跨事件关联）。 - `name` string, required — 工具名称。 - `arguments` string, required — 工具调用参数（JSON 字符串）。 - `language` 'json' | 'yaml' | 'python' | 'javascript' — 参数语言标注（可选）。 - `metadata` object — 扩展元数据。 - `previous_task_id` string — 前置任务 ID（用于续写/衔接）。 - `rollouts` object[] — 任务推演/回溯事件集合（可选）。 ## Other responses - `404` — Not Found - `422` — Validation Error --- [API](https://skmtc.net/stainless-api/apis/agentlin-api.md) · [All operations](https://skmtc.net/stainless-api/apis/agentlin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stainless-api/agentlin-api/versions/be7769091980/schema)