Search Threads

Search for threads.

This endpoint also functions as the endpoint to list all threads.

POST /threads/search

Search Threads

cURL

curl --request POST \
  --url https://api.example.com/threads/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "metadata": {},
  "values": {},
  "limit": 10,
  "offset": 0,
  "select": [],
  "extract": {}
}
'

import requests

url = "https://api.example.com/threads/search"

payload = {
    "ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "metadata": {},
    "values": {},
    "limit": 10,
    "offset": 0,
    "select": [],
    "extract": {}
}
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({
    ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    metadata: {},
    values: {},
    limit: 10,
    offset: 0,
    select: [],
    extract: {}
  })
};

fetch('https://api.example.com/threads/search', 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/search",
  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([
    'ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'metadata' => [
        
    ],
    'values' => [
        
    ],
    'limit' => 10,
    'offset' => 0,
    'select' => [
        
    ],
    'extract' => [
        
    ]
  ]),
  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/search"

	payload := strings.NewReader("{\n  \"ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"metadata\": {},\n  \"values\": {},\n  \"limit\": 10,\n  \"offset\": 0,\n  \"select\": [],\n  \"extract\": {}\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/search")
  .header("Content-Type", "application/json")
  .body("{\n  \"ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"metadata\": {},\n  \"values\": {},\n  \"limit\": 10,\n  \"offset\": 0,\n  \"select\": [],\n  \"extract\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/threads/search")

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  \"ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"metadata\": {},\n  \"values\": {},\n  \"limit\": 10,\n  \"offset\": 0,\n  \"select\": [],\n  \"extract\": {}\n}"

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

200

[
  {
    "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "state_updated_at": "2023-11-07T05:31:56Z",
    "config": {},
    "values": {},
    "interrupts": {},
    "ttl": {
      "ttl_minutes": 123,
      "expires_at": "2023-11-07T05:31:56Z"
    },
    "extracted": {}
  }
]

{
  "detail": "<string>"
}

Body

application/json

Payload for listing threads.

ids · string<uuid>[]

List of thread IDs to include. Others are excluded.

metadata · Metadata · object

Thread metadata to filter on.

values · Values · object

State values to filter on.

status · enum<string>

Thread status to filter on.

Available options: idle, busy, interrupted, error

limit · integer · default: 10

Maximum number to return.

Required range: 1 <= x <= 1000

offset · integer · default: 0

Offset to start from.

Required range: x >= 0

sort_by · enum<string>

Sort by field.

Available options: thread_id, status, created_at, updated_at, state_updated_at

sort_order · enum<string>

Sort order.

Available options: asc, desc

select · enum<string>[]

Specify which fields to return. If not provided, all fields are returned.

Available options: thread_id, created_at, updated_at, state_updated_at, metadata, config, status, values, interrupts

extract · Extract · object

Map of alias to JSONB path for extracting specific values. Paths must start with values, metadata, config, or interrupts. Example: {"last_msg": "values.messages[-1]"}.

Show child attributes

Response

200

application/json

Success

thread_id · string<uuid> · required

The ID of the thread.

created_at · string<date-time> · required

The time the thread was created.

updated_at · string<date-time> · required

The last time the thread was updated.

metadata · Metadata · object · required

The thread metadata.

status · enum<string> · required

The status of the thread.

Available options: idle, busy, interrupted, error

state_updated_at · string<date-time>

The last time the thread state was updated.

config · Config · object

The thread config.

values · Values · object

The current state of the thread.

interrupts · Interrupts · object

The current interrupts of the thread.

ttl · TTL Info · object

TTL information if set for this thread. Only present when ?include=ttl is passed.

Show child attributes

extracted · Extracted · object

Extracted values from thread JSONB columns, populated when extract is specified in search request.