Skip to main content
POST
/
threads
/
{thread_id}
/
state
/
checkpoint
Get Thread State At Checkpoint
curl --request POST \
  --url https://api.example.com/threads/{thread_id}/state/checkpoint \
  --header 'Content-Type: application/json' \
  --data '
{
  "checkpoint": {
    "thread_id": "<string>",
    "checkpoint_ns": "<string>",
    "checkpoint_id": "<string>",
    "checkpoint_map": {}
  },
  "subgraphs": true
}
'
{
  "values": [
    {}
  ],
  "next": [
    "<string>"
  ],
  "checkpoint": {
    "thread_id": "<string>",
    "checkpoint_ns": "<string>",
    "checkpoint_id": "<string>",
    "checkpoint_map": {}
  },
  "metadata": {},
  "created_at": "<string>",
  "tasks": [
    {
      "id": "<string>",
      "name": "<string>",
      "error": "<string>",
      "interrupts": [
        {
          "value": {},
          "id": "<string>"
        }
      ],
      "checkpoint": {
        "thread_id": "<string>",
        "checkpoint_ns": "<string>",
        "checkpoint_id": "<string>",
        "checkpoint_map": {}
      },
      "state": "<unknown>"
    }
  ],
  "parent_checkpoint": {},
  "interrupts": [
    {
      "value": {},
      "id": "<string>"
    }
  ]
}

Path Parameters

​
thread_id
string<uuid>
required

The ID of the thread.

Query Parameters

​
subgraphs
boolean

If true, includes subgraph states.

Body

application/json

Payload for getting the state of a thread at a checkpoint.

​
checkpoint
Checkpoint · object
required

The checkpoint to get the state for.

​
subgraphs
boolean

Include subgraph states.

Response

Success

​
values
object
required
​
next
string[]
required
​
checkpoint
Checkpoint · object
required

Checkpoint config.

​
metadata
Metadata · object
required
​
created_at
string
required
​
tasks
Tasks · object[]
​
parent_checkpoint
Parent Checkpoint · object
​
interrupts
Interrupt · object[]