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": [
    {
      "role": "user",
      "parts": [
        {
          "name": "<string>",
          "content_type": "text/plain",
          "content": "<string>",
          "content_encoding": "plain",
          "content_url": "<string>",
          "metadata": {
            "kind": "citation",
            "start_index": 123,
            "end_index": 123,
            "url": "<string>",
            "title": "<string>",
            "description": "<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"
}

Path Parameters

​
run_id
string
required

UUID of the run to cancel.

Response

202
application/json

Cancel request accepted

The response is of type object.