Get Thread State

Get state for a thread.

The latest state of the thread (i.e. latest checkpoint) is returned.

GET /threads/{thread_id}/state

Get Thread State

cURL

curl --request GET \
  --url https://api.example.com/threads/{thread_id}/state

import requests

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

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/threads/{thread_id}/state', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/threads/{thread_id}/state")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)

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.

Query Parameters

subgraphs · boolean

Whether to include subgraphs in the response.

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