取消任务 | Yeehoo Developers

取消尚未完成的生成任务，适合用户主动终止或业务超时清理场景。

这个接口用于取消尚未完成的生成任务。

POST /v1/tasks/{task_id}/cancel

接口概览

项	说明
路由	`POST /v1/tasks/{task_id}/cancel`
鉴权	`Authorization: Bearer sk_yeehoo_xxx`
路径参数	`task_id`
请求体	无
返回	`200 OK` + 最新任务对象

适用场景

用户主动取消
工作流超时回收
后台任务编排终止

Authorizations

Authorization: Bearer sk_yeehoo_your_api_key

Path Parameters

参数	类型	必填	说明
`task_id`	`string`	是	要取消的任务 ID

Response

取消成功后，通常返回任务最新状态。

{
  "task_id": "task_01jxyz...",
  "object": "task",
  "kind": "image",
  "model": "gpt-image-2",
  "status": "failed",
  "progress": 0,
  "created_at": 1784779200,
  "completed_at": 1784779210
}

接入建议

不要把取消能力当成默认流程，而是作为异常控制能力使用
是否能成功取消，取决于任务当时所处阶段
用户取消后，前端仍建议再查一次任务详情确认最终状态