Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-1318121242.5 KB
Tasks

Cancel an agent task

Cancels a model task with the given ID. Only tasks created with the background parameter set to true can be cancelled. Learn more.

post/tasks/{task_id}/cancel

Path parameters

task_idstring required

The ID of the task to cancel

The ID of the task to cancel

Response

Successful Response

object'task' required

固定为 task。

idstring required

任务 ID。

session_idstring required

会话 ID。

user_idstring 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_atinteger required

任务创建时间（Unix 秒）。

usageobject

token 用量统计信息。

metadataobject

扩展元数据。

previous_task_idstring

前置任务 ID（用于续写/衔接）。

rolloutsobject[]

任务推演/回溯事件集合（可选）。