List Checkpoints

checkpoints.list() -> CheckpointListResponse

POST/checkpoints/list

List Checkpoints

ParametersExpand Collapse

thread_id: str

before_checkpoint_id: Optional[str]

checkpoint_ns: Optional[str]

filter_metadata: Optional[Dict[str, object]]

limit: Optional[int]

ReturnsExpand Collapse

List[CheckpointListResponseItem]

checkpoint: Dict[str, object]

checkpoint_id: str

checkpoint_ns: str

metadata: Dict[str, object]

thread_id: str

parent_checkpoint_id: Optional[str]

List Checkpoints

import os
from agentex import Agentex

client = Agentex(
    api_key=os.environ.get("AGENTEX_SDK_API_KEY"),  # This is the default and can be omitted
)
checkpoints = client.checkpoints.list(
    thread_id="thread_id",
)
print(checkpoints)

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

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