Skip to main content
POST
/
assistants
/
search
Search Assistants
curl --request POST \
  --url https://api.example.com/assistants/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "graph_id": "<string>",
  "limit": 20,
  "offset": 0,
  "metadata": {}
}
'
[
  {
    "assistant_id": "<string>",
    "name": "<string>",
    "graph_id": "<string>",
    "user_id": "<string>",
    "version": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "config": {},
    "context": {},
    "metadata_dict": {}
  }
]

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

Metadata to use for searching and filtering assistants.

Response

Successful Response

​
assistant_id
string
required

Unique identifier for the assistant.

​
name
string
required

Human-readable name of the assistant.

​
graph_id
string
required

Identifier of the graph this assistant executes.

​
user_id
string
required

Identifier of the user who owns this assistant.

​
version
integer
required

The version of the assistant.

​
created_at
string<date-time>
required

Timestamp when the assistant was created.

​
updated_at
string<date-time>
required

Timestamp when the assistant was last updated.

​
description
string | null

Optional description of the assistant's purpose.

​
config
Config · object

Configuration passed to the graph at runtime.

​
context
Context · object

Context variables available to the graph during execution.

​
metadata_dict
Metadata Dict · object

Arbitrary metadata for searching and filtering.