Skip to main content
POST
/
threads
/
{thread_id}
/
history
Get Thread History Post
curl --request POST \
  --url https://api.example.com/threads/{thread_id}/history \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 1,
  "before": {
    "thread_id": "<string>",
    "checkpoint_ns": "<string>",
    "checkpoint_id": "<string>",
    "checkpoint_map": {}
  },
  "metadata": {},
  "checkpoint": {
    "thread_id": "<string>",
    "checkpoint_ns": "<string>",
    "checkpoint_id": "<string>",
    "checkpoint_map": {}
  }
}
'
import requests

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

payload = {
    "limit": 1,
    "before": {
        "thread_id": "<string>",
        "checkpoint_ns": "<string>",
        "checkpoint_id": "<string>",
        "checkpoint_map": {}
    },
    "metadata": {},
    "checkpoint": {
        "thread_id": "<string>",
        "checkpoint_ns": "<string>",
        "checkpoint_id": "<string>",
        "checkpoint_map": {}
    }
}
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({
    limit: 1,
    before: {
      thread_id: '<string>',
      checkpoint_ns: '<string>',
      checkpoint_id: '<string>',
      checkpoint_map: {}
    },
    metadata: {},
    checkpoint: {
      thread_id: '<string>',
      checkpoint_ns: '<string>',
      checkpoint_id: '<string>',
      checkpoint_map: {}
    }
  })
};

fetch('https://api.example.com/threads/{thread_id}/history', 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}/history",
  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([
    'limit' => 1,
    'before' => [
        'thread_id' => '<string>',
        'checkpoint_ns' => '<string>',
        'checkpoint_id' => '<string>',
        'checkpoint_map' => [
                
        ]
    ],
    'metadata' => [
        
    ],
    'checkpoint' => [
        'thread_id' => '<string>',
        'checkpoint_ns' => '<string>',
        'checkpoint_id' => '<string>',
        'checkpoint_map' => [
                
        ]
    ]
  ]),
  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}/history"

	payload := strings.NewReader("{\n  \"limit\": 1,\n  \"before\": {\n    \"thread_id\": \"<string>\",\n    \"checkpoint_ns\": \"<string>\",\n    \"checkpoint_id\": \"<string>\",\n    \"checkpoint_map\": {}\n  },\n  \"metadata\": {},\n  \"checkpoint\": {\n    \"thread_id\": \"<string>\",\n    \"checkpoint_ns\": \"<string>\",\n    \"checkpoint_id\": \"<string>\",\n    \"checkpoint_map\": {}\n  }\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}/history")
  .header("Content-Type", "application/json")
  .body("{\n  \"limit\": 1,\n  \"before\": {\n    \"thread_id\": \"<string>\",\n    \"checkpoint_ns\": \"<string>\",\n    \"checkpoint_id\": \"<string>\",\n    \"checkpoint_map\": {}\n  },\n  \"metadata\": {},\n  \"checkpoint\": {\n    \"thread_id\": \"<string>\",\n    \"checkpoint_ns\": \"<string>\",\n    \"checkpoint_id\": \"<string>\",\n    \"checkpoint_map\": {}\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"limit\": 1,\n  \"before\": {\n    \"thread_id\": \"<string>\",\n    \"checkpoint_ns\": \"<string>\",\n    \"checkpoint_id\": \"<string>\",\n    \"checkpoint_map\": {}\n  },\n  \"metadata\": {},\n  \"checkpoint\": {\n    \"thread_id\": \"<string>\",\n    \"checkpoint_ns\": \"<string>\",\n    \"checkpoint_id\": \"<string>\",\n    \"checkpoint_map\": {}\n  }\n}"

response = http.request(request)
puts response.read_body
[
  {
    "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
limit
integer
default:1

The maximum number of states to return.

Required range: 1 <= x <= 1000
before
Before · object

Return states before this checkpoint.

metadata
Metadata · object

Filter states by metadata key-value pairs.

checkpoint
Checkpoint · object

Return states for this subgraph.

Response

Success

values
object
required
next
string[]
required
checkpoint
Checkpoint · object
required

Checkpoint config.

metadata
Metadata · object
required
created_at
string
required
tasks
Tasks · object[]
parent_checkpoint
Parent Checkpoint · object
interrupts
Interrupt · object[]