Get Thread State At Checkpoint

Get state for a thread at a specific checkpoint.

POST /threads/{thread_id}/state/checkpoint

Get Thread State At Checkpoint

cURL

curl --request POST \
  --url https://api.example.com/threads/{thread_id}/state/checkpoint \
  --header 'Content-Type: application/json' \
  --data '
{
  "checkpoint": {
    "thread_id": "<string>",
    "checkpoint_ns": "<string>",
    "checkpoint_id": "<string>",
    "checkpoint_map": {}
  },
  "subgraphs": true
}
'

import requests

url = "https://api.example.com/threads/{thread_id}/state/checkpoint"

payload = {
    "checkpoint": {
        "thread_id": "<string>",
        "checkpoint_ns": "<string>",
        "checkpoint_id": "<string>",
        "checkpoint_map": {}
    },
    "subgraphs": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    checkpoint: {
      thread_id: '<string>',
      checkpoint_ns: '<string>',
      checkpoint_id: '<string>',
      checkpoint_map: {}
    },
    subgraphs: true
  })
};

fetch('https://api.example.com/threads/{thread_id}/state/checkpoint', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/threads/{thread_id}/state/checkpoint",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'checkpoint' => [
        'thread_id' => '<string>',
        'checkpoint_ns' => '<string>',
        'checkpoint_id' => '<string>',
        'checkpoint_map' => [
                
        ]
    ],
    'subgraphs' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/threads/{thread_id}/state/checkpoint"

	payload := strings.NewReader("{\n  \"checkpoint\": {\n    \"thread_id\": \"<string>\",\n    \"checkpoint_ns\": \"<string>\",\n    \"checkpoint_id\": \"<string>\",\n    \"checkpoint_map\": {}\n  },\n  \"subgraphs\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/threads/{thread_id}/state/checkpoint")
  .header("Content-Type", "application/json")
  .body("{\n  \"checkpoint\": {\n    \"thread_id\": \"<string>\",\n    \"checkpoint_ns\": \"<string>\",\n    \"checkpoint_id\": \"<string>\",\n    \"checkpoint_map\": {}\n  },\n  \"subgraphs\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/threads/{thread_id}/state/checkpoint")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"checkpoint\": {\n    \"thread_id\": \"<string>\",\n    \"checkpoint_ns\": \"<string>\",\n    \"checkpoint_id\": \"<string>\",\n    \"checkpoint_map\": {}\n  },\n  \"subgraphs\": true\n}"

response = http.request(request)
puts response.read_body

200

{
  "values": [
    {}
  ],
  "next": [
    "<string>"
  ],
  "checkpoint": {
    "thread_id": "<string>",
    "checkpoint_ns": "<string>",
    "checkpoint_id": "<string>",
    "checkpoint_map": {}
  },
  "metadata": {},
  "created_at": "<string>",
  "tasks": [
    {
      "id": "<string>",
      "name": "<string>",
      "error": "<string>",
      "interrupts": [
        {
          "value": {},
          "id": "<string>"
        }
      ],
      "checkpoint": {
        "thread_id": "<string>",
        "checkpoint_ns": "<string>",
        "checkpoint_id": "<string>",
        "checkpoint_map": {}
      },
      "state": "<unknown>"
    }
  ],
  "parent_checkpoint": {},
  "interrupts": [
    {
      "value": {},
      "id": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

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.

Show child attributes

subgraphs · boolean

Include subgraph states.

Response

200

application/json

Success

values · object · required

Values · object[]

Values · object

next · string[] · required

checkpoint · Checkpoint · object · required

Checkpoint config.

Show child attributes

metadata · Metadata · object · required

created_at · string · required

tasks · Tasks · object[]

Show child attributes

parent_checkpoint · Parent Checkpoint · object

interrupts · Interrupt · object[]

Show child attributes