FruxonDocs
AgentsExecution Records

Terminally cancels a parked run, ending the execution.

The stronger counterpart to `:cancelWait`. Where cancelling the wait resolves the consult and <b>resumes</b> the run (so the agent can re-issue the same consult and re-park), this kills the run: every op the task is parked on is torn down, the task is flipped to a terminal state that never resumes, and the execution record is marked `Cancelled`. Use it when the run is stuck in a re-consult loop and skipping the single consult would not end it. Only a run parked `WAITING_FOR_ASYNC` can be cancelled.

POST
/v1/tenants/{tenant}/agents/{agent}/executionRecords/{executionRecord}:cancelRun
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

agent*string

The unique identifier of the agent.

executionRecord*string

The parked execution record to cancel.

tenant*string

The tenant identifier

Optional cancellation reason.

reason?string|null

Optional free-text reason recorded on the cancelled operation(s) and in the audit log.

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/agents/string/executionRecords/string:cancelRun" \  -H "Content-Type: application/json" \  -d '{}'
Empty
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}