POST
/
runs
/
{run_id}
/
cancel
curl --request POST \
  --url http://localhost:8333/api/v0/runs/{run_id}/cancel
{
  "agent_name": "chat",
  "session_id": "<string>",
  "run_id": "<string>",
  "status": "created",
  "await": {},
  "output": [
    {
      "type": "<string>",
      "content": "<string>"
    }
  ]
}

This is an Alpha version still in active development; its structure, interfaces, and functionality are changing frequently as the design evolves. Join the GitHub discussions to help shape it.

Response

202
application/json
Run cancelling
​
agent_name
string

Name of the agent

Example:

"chat"

​
session_id
string

Identifier of a session

​
run_id
string

Identifier of a run

​
status
enum<string>

Status of the run

Available options:
created,
in-progress,
awaiting,
cancelling,
cancelled,
completed,
failed
​
await
object | null

Description of the awaited payload to resume the run, only available when status is awaiting

​
output
object[]

Output of the run, only available once run has completed