Skip to content

Get Checkpoint Tuple

POST/checkpoints/get-tuple

Get Checkpoint Tuple

Body ParametersJSONExpand Collapse
thread_id: string
checkpoint_id: optional string
checkpoint_ns: optional string
ReturnsExpand Collapse
checkpoint: map[unknown]
checkpoint_id: string
checkpoint_ns: string
metadata: map[unknown]
thread_id: string
blobs: optional array of object { channel, type, version, blob }
channel: string
type: string
version: string
blob: optional string
parent_checkpoint_id: optional string
pending_writes: optional array of object { channel, idx, task_id, 2 more }
channel: string
idx: number
task_id: string
blob: optional string
type: optional string

Get Checkpoint Tuple

curl http://localhost:5003/checkpoints/get-tuple \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY" \
    -d '{
          "thread_id": "thread_id"
        }'
{
  "checkpoint": {
    "foo": "bar"
  },
  "checkpoint_id": "checkpoint_id",
  "checkpoint_ns": "checkpoint_ns",
  "metadata": {
    "foo": "bar"
  },
  "thread_id": "thread_id",
  "blobs": [
    {
      "channel": "channel",
      "type": "type",
      "version": "version",
      "blob": "blob"
    }
  ],
  "parent_checkpoint_id": "parent_checkpoint_id",
  "pending_writes": [
    {
      "channel": "channel",
      "idx": 0,
      "task_id": "task_id",
      "blob": "blob",
      "type": "type"
    }
  ]
}
Returns Examples
{
  "checkpoint": {
    "foo": "bar"
  },
  "checkpoint_id": "checkpoint_id",
  "checkpoint_ns": "checkpoint_ns",
  "metadata": {
    "foo": "bar"
  },
  "thread_id": "thread_id",
  "blobs": [
    {
      "channel": "channel",
      "type": "type",
      "version": "version",
      "blob": "blob"
    }
  ],
  "parent_checkpoint_id": "parent_checkpoint_id",
  "pending_writes": [
    {
      "channel": "channel",
      "idx": 0,
      "task_id": "task_id",
      "blob": "blob",
      "type": "type"
    }
  ]
}