API Reference

Checkpoints

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Checkpoints

POST/checkpoints/list

List Checkpoints

Body ParametersJSONExpand Collapse

thread_id: string

before_checkpoint_id: optional string

checkpoint_ns: optional string

filter_metadata: optional map[unknown]

limit: optional number

ReturnsExpand Collapse

checkpoint: map[unknown]

checkpoint_id: string

checkpoint_ns: string

metadata: map[unknown]

thread_id: string

parent_checkpoint_id: optional string

List Checkpoints

HTTP

HTTP

TypeScript

Python

curl http://localhost:5003/checkpoints/list \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY" \
    -d '{
          "thread_id": "thread_id"
        }'

200 example

[
  {
    "checkpoint": {
      "foo": "bar"
    },
    "checkpoint_id": "checkpoint_id",
    "checkpoint_ns": "checkpoint_ns",
    "metadata": {
      "foo": "bar"
    },
    "thread_id": "thread_id",
    "parent_checkpoint_id": "parent_checkpoint_id"
  }
]

Returns Examples

200 example

[
  {
    "checkpoint": {
      "foo": "bar"
    },
    "checkpoint_id": "checkpoint_id",
    "checkpoint_ns": "checkpoint_ns",
    "metadata": {
      "foo": "bar"
    },
    "thread_id": "thread_id",
    "parent_checkpoint_id": "parent_checkpoint_id"
  }
]