Skip to main content
POST
/
api
/
v1
/
agents
/
{agentId}
/
tasks
/
{taskId}
/
cancel
Cancel an in-flight task.
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
  }
}

Authorizations

​
Authorization
string
header
required

Pass a user JWT or a oag_ User API Key on the Authorization: Bearer <token> header. Both are validated by openapi-gateway against the Auth service.

Both credential types are user-scoped: every key (and every JWT) is bound to exactly one owner, and every route grants the caller full access to that owner's own resources. Cross-tenant access is denied by owner-ACL inside the handlers — there is no per-route scope vocabulary on this API.

Removed in v1.1.0: the legacy agents:* / tasks:* / files:* / instances:* scope set has been dropped together with the 403 insufficient_scope error. Existing oag_ keys automatically gain full owner-level access and do not need to be re-issued. SDK calls that previously passed scopes to createAPIKey should drop the argument. See the changelog at the bottom of this spec for the full migration note.

Path Parameters

​
agentId
string
required
Maximum string length: 128
​
taskId
string
required
Maximum string length: 128

Body

application/json
​
reason
string

Free-form caller label propagated on the chat_cancel envelope payload so the agent can audit-log why its turn was aborted. Empty defaults to canceled.

Response

Post-cancel task snapshot.

​
success
boolean
required
​
data
object
required