Skip to main content
POST
/
checkpoints
/
list
List Checkpoints
curl --request POST \
  --url https://api.example.com/checkpoints/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "thread_id": "<string>",
  "checkpoint_ns": "<string>",
  "before_checkpoint_id": "<string>",
  "filter_metadata": {},
  "limit": 100
}
'
[
  {
    "thread_id": "<string>",
    "checkpoint_ns": "<string>",
    "checkpoint_id": "<string>",
    "checkpoint": {},
    "metadata": {},
    "parent_checkpoint_id": "<string>"
  }
]

Body

application/json
​
thread_id
string
required
​
checkpoint_ns
string | null
​
before_checkpoint_id
string | null
​
filter_metadata
Metadata filter (JSONB @>) · object
​
limit
integer
default:100
Required range: 1 <= x <= 1000

Response

Successful Response

​
thread_id
string
required
​
checkpoint_ns
string
required
​
checkpoint_id
string
required
​
checkpoint
Checkpoint · object
required
​
metadata
Metadata · object
required
​
parent_checkpoint_id
string | null