Skip to main content
POST
Search Threads

Body

application/json

Payload for listing threads.

ids
string<uuid>[]

List of thread IDs to include. Others are excluded.

metadata
Metadata · object

Thread metadata to filter on.

values
Values · object

State values to filter on.

status
enum<string>

Thread status to filter on.

Available options:
idle,
busy,
interrupted,
error
limit
integer
default:10

Maximum number to return.

Required range: 1 <= x <= 1000
offset
integer
default:0

Offset to start from.

Required range: x >= 0
sort_by
enum<string>

Sort by field.

Available options:
thread_id,
status,
created_at,
updated_at,
state_updated_at
sort_order
enum<string>

Sort order.

Available options:
asc,
desc
select
enum<string>[]

Specify which fields to return. If not provided, all fields are returned.

Available options:
thread_id,
created_at,
updated_at,
state_updated_at,
metadata,
config,
status,
values,
interrupts
extract
Extract · object

Map of alias to JSONB path for extracting specific values. Paths must start with values, metadata, config, or interrupts. Example: {"last_msg": "values.messages[-1]"}.

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
state_updated_at
string<date-time>

The last time the thread state was updated.

config
Config · object

The thread config.

values
Values · object

The current state of the thread.

interrupts
Interrupts · object

The current interrupts of the thread.

ttl
TTL Info · object

TTL information if set for this thread. Only present when ?include=ttl is passed.

extracted
Extracted · object

Extracted values from thread JSONB columns, populated when extract is specified in search request.