Skip to main content
GET
/
threads
/
{thread_id}
Get Thread
curl --request GET \
  --url https://api.example.com/threads/{thread_id}
{
  "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "status": "idle",
  "state_updated_at": "2023-11-07T05:31:56Z",
  "config": {},
  "values": {},
  "interrupts": {},
  "ttl": {
    "strategy": "delete",
    "ttl_minutes": 123,
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "extracted": {}
}

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.

​
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.