Get Thread State At Checkpoint

Get state for a thread at a specific checkpoint.

POST /threads/{thread_id}/state/checkpoint

Get Thread State At Checkpoint

cURL

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
}
'

200

{
  "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.

Show child attributes

subgraphs · boolean

Include subgraph states.

Response

200

application/json

Success

values · object · required

Values · object[]

Values · object

next · string[] · required

checkpoint · Checkpoint · object · required

Checkpoint config.

Show child attributes

metadata · Metadata · object · required

created_at · string · required

tasks · Tasks · object[]

Show child attributes

parent_checkpoint · Parent Checkpoint · object

interrupts · Interrupt · object[]

Show child attributes