agent-runs

Cancel an agent run

Requests cancellation of a running agent run. Cancellation is asynchronous — poll GET /v1/agent-runs/{id} to observe the terminal "cancelled" phase.

post/v1/agent-runs/{id}/cancel

Request

  • Base URL
    https://api.b3os.org (the document declares no server; this is the origin it was published from)
  • URL
    https://api.b3os.org/v1/agent-runs/{id}/cancel
  • Auth
    API key in header Authorization

Path parameters

idstring required

Run ID

Response

OK

codeinteger
messagestring
requestIdstring

Example response

{
  "code": 200,
  "data": {
    "ok": true
  },
  "message": "success",
  "requestId": "abc-123"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.