Create a thread

Create a thread, optionally bound to an agent. Subsequent runs are started on it via POST /v1/fleet/threads/{thread_id}/runs/stream.

POST /v1/fleet/threads

Error

A valid request URL is required to generate request examples

201

{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Body

application/json

agent_id · string

Example:

"11111111-1111-1111-1111-111111111111"

if_exists · enum<string>

Available options: do_nothing, raise

metadata · object

Show child attributes

options · object

Show child attributes

thread_id · string<uuid>

Response

201

application/json

Created

agent_id · string<uuid>

created_at · string<date-time>

id · string<uuid>

metadata · object

Show child attributes

status · enum<string>

Available options: idle, busy, interrupted, error

updated_at · string<date-time>