Skip to main content
POST
Create Thread

Body

application/json

Payload for creating a thread.

thread_id
string<uuid>

The ID of the thread. If not provided, a random UUID will be generated.

metadata
Metadata · object

Metadata to add to thread.

if_exists
enum<string>
default:raise

How to handle duplicate creation. Must be either 'raise' (raise error if duplicate), or 'do_nothing' (return existing thread).

Available options:
raise,
do_nothing
ttl
TTL · object

The time-to-live for the thread.

supersteps
object[]

Response

Success

thread_id
string<uuid>
required

The ID of the thread.

created_at
string<date-time>
required

The time the thread was created.

updated_at
string<date-time>
required

The last time the thread was updated.

metadata
Metadata · object
required

The thread metadata.

status
enum<string>
required

The status of the thread.

Available options:
idle,
busy,
interrupted,
error
config
Config · object

The thread config.

values
Values · object

The current state of the thread.

interrupts
Interrupts · object

The current interrupts of the thread.