Skip to main content
POST
/
runs
Create a new run
curl --request POST \
  --url http://localhost:8000/runs \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_name": "chat",
  "input": [
    {
      "role": "<string>",
      "parts": [
        {
          "content_type": "text/plain",
          "name": "<string>",
          "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"
    }
  ],
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "history": [
      "<string>"
    ],
    "state": "<string>"
  },
  "mode": "sync"
}
'
{
  "agent_name": "chat",
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "created",
  "output": [
    {
      "role": "<string>",
      "parts": [
        {
          "content_type": "text/plain",
          "name": "<string>",
          "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"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "await_request": {},
  "error": {
    "code": "server_error",
    "message": "<string>",
    "data": {}
  },
  "finished_at": "2023-11-07T05:31:56Z"
}

Body

application/json
​
agent_name
string
required

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

Required string length: 1 - 63
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
Example:

"chat"

​
input
object[]
required
Minimum array length: 1
​
session_id
string<uuid>

Identifier of a session

​
session
object
​
mode
enum<string>

Mode of the request

Available options:
sync,
async,
stream

Response

Run started (streaming or immediate)

​
agent_name
string
required

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

Required string length: 1 - 63
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
Example:

"chat"

​
run_id
string<uuid>
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<date-time>
required
​
session_id
string<uuid>

Identifier of a session

​
await_request
object

Payload describing what is awaited from the client to continue the run.

​
error
object
​
finished_at
string<date-time>