跳转到主要内容
POST
/
api
/
v1
/
agents
/
{agentId}
/
tasks
/
{taskId}
/
cancel
取消进行中的任务。
curl --request POST \
  --url https://openapi.beeos.ai/api/v1/agents/{agentId}/tasks/{taskId}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'
{
  "success": true,
  "data": {
    "task_id": "<string>",
    "agent_id": "<string>",
    "caller_id": "<string>",
    "result": "<unknown>",
    "error": "<string>",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "deadline_at": "2023-11-07T05:31:56Z",
    "truncated": true
  }
}

授权

​
Authorization
string
header
必填

通过 Authorization: Bearer <token> header 传用户 JWT 或 oag_ User API Key。两者都由 openapi-gateway 对 Auth service 验证。

JWT 与 API Key 都是 user-scoped：每个 key（以及每个 JWT） 绑定到唯一 owner，所有路由都自动放开该 owner 名下的全部资源。 跨租户访问由 handler 内的 owner-ACL 拦截 —— API 表面没有 per-route scope 词汇。

v1.1.0 已移除： 历史 scope 词汇（agents:* / tasks:* / files:* / instances:*）以及 403 insufficient_scope 错误码已下线。已签发的 oag_ key 自动获得 owner 全权限， 无需重建。之前显式传 scopes 调用 createAPIKey 的 SDK 客户端可以直接删除该参数。详见文末 changelog 迁移说明。

路径参数

​
agentId
string
必填
Maximum string length: 128
​
taskId
string
必填
Maximum string length: 128

请求体

application/json
​
reason
string

自由格式调用方 label，传播到 chat_cancel 信封 payload 让 智能体审计日志记录回合 abort 的原因。空时默认 canceled。

响应

cancel 后的任务快照。

​
success
boolean
必填
​
data
object
必填