Skip to main content
GET
Get Thread

Path Parameters

thread_id
string<uuid>
required

The ID of the thread.

Query Parameters

include
string

Comma-separated list of additional fields to include.

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.

run_priority
integer | null

The queue priority level of the thread's runs, from -5 (highest priority) to 5 (lowest priority). Set at the thread's first run; null until then.

Required range: -5 <= x <= 5
fairness_group
string | null

A label for the thread's runs, such as a tenant or customer ID, kept for sharing workers fairly between tenants; scheduling doesn't use it yet. Set at the thread's first run with a default of "default"; null until then.

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.