Skip to main content
POST
/
assistants
/
count
Count Assistants
curl --request POST \
  --url https://api.example.com/assistants/count \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "graph_id": "<string>",
  "limit": 20,
  "offset": 0,
  "metadata": {}
}
'
import requests

url = "https://api.example.com/assistants/count"

payload = {
"name": "<string>",
"description": "<string>",
"graph_id": "<string>",
"limit": 20,
"offset": 0,
"metadata": {}
}
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({
name: '<string>',
description: '<string>',
graph_id: '<string>',
limit: 20,
offset: 0,
metadata: {}
})
};

fetch('https://api.example.com/assistants/count', 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/assistants/count",
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([
'name' => '<string>',
'description' => '<string>',
'graph_id' => '<string>',
'limit' => 20,
'offset' => 0,
'metadata' => [

]
]),
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/assistants/count"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"graph_id\": \"<string>\",\n \"limit\": 20,\n \"offset\": 0,\n \"metadata\": {}\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/assistants/count")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"graph_id\": \"<string>\",\n \"limit\": 20,\n \"offset\": 0,\n \"metadata\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/assistants/count")

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 \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"graph_id\": \"<string>\",\n \"limit\": 20,\n \"offset\": 0,\n \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
123
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Body

application/json

Request model for assistant search

name
string | null

Filter by assistant name

description
string | null

Filter by assistant description

graph_id
string | null

Filter by graph ID

limit
integer | null
default:20

Maximum results

Required range: 1 <= x <= 100
offset
integer | null
default:0

Results offset

Required range: x >= 0
metadata
Metadata · object | null

Metadata to use for searching and filtering assistants.

sort_by
enum<string> | null

Field to sort by (SDK-compatible).

Available options:
assistant_id,
name,
graph_id,
created_at,
updated_at
sort_order
enum<string> | null

Sort direction (SDK-compatible). Defaults to 'desc' when sort_by is set.

Available options:
asc,
desc

Response

Successful Response

The response is of type integer.