Skip to main content
POST
Get Thread State At Checkpoint

Path Parameters

thread_id
string<uuid>
required

The ID of the thread.

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.

select
(enum<string> | string)[]

Specify which fields of the state to return. Use values.<key> to return only that key of the state values, for example values.messages. If not provided, all fields are returned.

Available options:
values,
next,
tasks,
checkpoint,
metadata,
created_at,
parent_checkpoint,
interrupts

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[]