Update Thread State

Add state to a thread.

POST /threads/{thread_id}/state

Update Thread State

cURL

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

import requests

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

payload = {
    "values": ["<unknown>"],
    "checkpoint": {
        "thread_id": "<string>",
        "checkpoint_ns": "<string>",
        "checkpoint_id": "<string>",
        "checkpoint_map": {}
    },
    "as_node": "<string>"
}
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({
    values: ['<unknown>'],
    checkpoint: {
      thread_id: '<string>',
      checkpoint_ns: '<string>',
      checkpoint_id: '<string>',
      checkpoint_map: {}
    },
    as_node: '<string>'
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'values' => [
        '<unknown>'
    ],
    'checkpoint' => [
        'thread_id' => '<string>',
        'checkpoint_ns' => '<string>',
        'checkpoint_id' => '<string>',
        'checkpoint_map' => [
                
        ]
    ],
    'as_node' => '<string>'
  ]),
  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"

	payload := strings.NewReader("{\n  \"values\": [\n    \"<unknown>\"\n  ],\n  \"checkpoint\": {\n    \"thread_id\": \"<string>\",\n    \"checkpoint_ns\": \"<string>\",\n    \"checkpoint_id\": \"<string>\",\n    \"checkpoint_map\": {}\n  },\n  \"as_node\": \"<string>\"\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")
  .header("Content-Type", "application/json")
  .body("{\n  \"values\": [\n    \"<unknown>\"\n  ],\n  \"checkpoint\": {\n    \"thread_id\": \"<string>\",\n    \"checkpoint_ns\": \"<string>\",\n    \"checkpoint_id\": \"<string>\",\n    \"checkpoint_map\": {}\n  },\n  \"as_node\": \"<string>\"\n}")
  .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::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"values\": [\n    \"<unknown>\"\n  ],\n  \"checkpoint\": {\n    \"thread_id\": \"<string>\",\n    \"checkpoint_ns\": \"<string>\",\n    \"checkpoint_id\": \"<string>\",\n    \"checkpoint_map\": {}\n  },\n  \"as_node\": \"<string>\"\n}"

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

200

{
  "checkpoint": {}
}

{
  "detail": "<string>"
}

Path Parameters

thread_id · string<uuid> · required

The ID of the thread.

Body

application/json

Payload for updating the state of a thread.

values · any[] Values · object

The values to update the state with.

checkpoint · Checkpoint · object

The checkpoint to update the state of.

Show child attributes

as_node · string

Update the state as if this node had just executed.

Response

200

application/json

Success

Response for adding state to a thread.

checkpoint · Checkpoint · object