POST
/
runs
/
{run_id}
/
cancel
curl --request POST \
  --url http://localhost:8000/runs/{run_id}/cancel
{
  "agent_name": "chat",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "created",
  "await_request": {},
  "output": [
    {
      "parts": [
        {
          "name": "<string>",
          "content_type": "text/plain",
          "content": "<string>",
          "content_encoding": "plain",
          "content_url": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "error": {
    "code": "server_error",
    "message": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z"
}

Response

202
application/json
Run cancelling
​
agent_name
string
required

A unique identifier for the agent following the RFC 1123 DNS-label naming convention.

Example:

"chat"

​
run_id
string
required

Identifier of a run

​
status
enum<string>
required

Status of the run

Available options:
created,
in-progress,
awaiting,
cancelling,
cancelled,
completed,
failed
​
output
object[]
required
​
created_at
string
required
​
session_id
string

Identifier of a session

​
await_request
object

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

​
error
object
​
finished_at
string