Create a new run

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

Example:

"chat"

input

object[]

required

Minimum array length: 1

Show child attributes

input.role

string

required

Specifies the sender of the message. Allowed values:

"user" for messages sent by an end-user.
"agent for anonymous agent.
"agent/{agent_name}" for messages sent by an agent, where {agent_name} is the identifier of the agent.

input.parts

object[]

required

Ordered sequence of message parts

Minimum array length: 1

Show child attributes

input.parts.content_type

string

default:text/plain

required

input.parts.name

string

input.parts.content

string

input.parts.content_encoding

enum<string>

default:plain

Available options:

plain,

base64

input.parts.content_url

string<uri>

input.parts.metadata

object

Represents an inline citation, providing info about information source. This is supposed to be rendered as an inline icon, optionally marking a text range it belongs to. If CitationMetadata is included together with content in the message part, the citation belongs to that content and renders at the MessagePart position. This way may be used for non-text content, like images and files. Alternatively, start_index and end_index may define a text range, counting characters in the current Message across all MessageParts with content type text/*, where the citation will be rendered. If one of start_index and end_index is missing or their values are equal, the citation renders only as an inline icon at that position. If both start_index and end_index are not present and MessagePart has no content, the citation renders as inline icon only at the MessagePart position.

Option 1
Option 2

Show child attributes

input.parts.metadata.kind

string

default:citation

required

Allowed value: "citation"

input.parts.metadata.start_index

integer | null

input.parts.metadata.end_index

integer | null

input.parts.metadata.url

string | null

input.parts.metadata.title

string | null

input.parts.metadata.description

string | null

Accompanying text, which may be a general description of the source document, or a specific snippet.

input.created_at

string<date-time>

input.completed_at

string<date-time>

session_id

string<uuid>

Identifier of a session

session

object

Show child attributes

session.id

string<uuid>

required

Identifier of a session

session.history

string<uri>[]

required

session.state

string<uri>

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

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

Show child attributes

output.role

string

required

Specifies the sender of the message. Allowed values:

"user" for messages sent by an end-user.
"agent for anonymous agent.
"agent/{agent_name}" for messages sent by an agent, where {agent_name} is the identifier of the agent.

output.parts

object[]

required

Ordered sequence of message parts

Minimum array length: 1

Show child attributes

output.parts.content_type

string

default:text/plain

required

output.parts.name

string

output.parts.content

string

output.parts.content_encoding

enum<string>

default:plain

Available options:

plain,

base64

output.parts.content_url

string<uri>

output.parts.metadata

object

Option 1
Option 2

Show child attributes

output.parts.metadata.kind

string

default:citation

required

Allowed value: "citation"

output.parts.metadata.start_index

integer | null

output.parts.metadata.end_index

integer | null

output.parts.metadata.url

string | null

output.parts.metadata.title

string | null

output.parts.metadata.description

string | null

Accompanying text, which may be a general description of the source document, or a specific snippet.

output.created_at

string<date-time>

output.completed_at

string<date-time>

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

Show child attributes

error.code

enum<string>

required

Available options:

server_error,

invalid_input,

not_found

error.message

string

required

error.data

object

finished_at

string<date-time>

Get run statusReturns the current status and details of a run.

⌘I

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"
}

Introduction

Core Concepts

How To

REST API

Integrations

About

Body

Response