Get Thread State

Get the current state of a thread.

Returns the latest checkpoint’s values, pending next nodes, interrupt data, and metadata. If the thread has no associated graph yet (no runs executed), returns an empty state.

GET /threads/{thread_id}/state

Get Thread State

cURL

curl --request GET \
  --url https://api.example.com/threads/{thread_id}/state

200

{
  "values": {},
  "checkpoint": {
    "checkpoint_id": "<string>",
    "thread_id": "<string>",
    "checkpoint_ns": ""
  },
  "next": [
    "<string>"
  ],
  "tasks": [
    {}
  ],
  "interrupts": [
    {}
  ],
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "parent_checkpoint": {
    "checkpoint_id": "<string>",
    "thread_id": "<string>",
    "checkpoint_ns": ""
  },
  "checkpoint_id": "<string>",
  "parent_checkpoint_id": "<string>"
}

Path Parameters

thread_id · string · required

Query Parameters

subgraphs · boolean · default: false

Include states from subgraphs

checkpoint_ns · string | null

Checkpoint namespace to scope lookup

Response

200

application/json

Successful Response

Thread state model for history endpoint

values · Values · object · required

Channel values (messages, etc.)

checkpoint · ThreadCheckpoint · object · required

Current checkpoint

Show child attributes

next · string[]

Next nodes to execute

tasks · Tasks · object[]

Tasks to execute

interrupts · Interrupts · object[]

Interrupt data

metadata · Metadata · object

Checkpoint metadata

created_at · string<date-time> | null

Timestamp of state creation

parent_checkpoint · ThreadCheckpoint · object

Parent checkpoint

Show child attributes

checkpoint_id · string | null

Checkpoint ID (for backward compatibility)

parent_checkpoint_id · string | null

Parent checkpoint ID (for backward compatibility)