Search Agents

Version 4.0.26.4 (latest)

Search Agents

Returns an array of agent objects that match the specified search criteria.

The parameters limit, and offset are recommended for fetching results in page-size chunks.

Get a single agent by id with get_agent()

Request

GET /agents/search
Datatype
Description
Request
HTTP Request
query
HTTP Query
Expand HTTP Query definition...
id
string
Match agent id. Can be a comma-separated list of ids.
name
string
Match agent name.
description
string
Match agent description.
created_by_user_id
string
Filter on agents created by a particular user.
fields
string
Requested fields.
limit
integer
Number of results to return. (used with offset)
category
string
Filter on agent category. Can be a comma-separated list of categories.
offset
integer
Number of results to skip before returning. (used with limit)
sorts
string
One or more fields to sort by. Sortable fields: [:id, :name, :description, :created_by_user_id, :created_at, :content_metadata_id, :category]
filter_or
boolean
Combine given search criteria in a boolean OR expression
not_owned_by
boolean
Filter out the agents owned by the user passed at the :created_by_user_id params
deleted
boolean
Filter on soft deleted agents.

Response

200: agents

Datatype
Description
(array)
Agent[]
can
object
Operations the current user is able to perform on this object
id
string
Agent unique identifier
created_by_user_id
string
User that created the Agent
created_by_name
string
Name of user that created the Agent
created_by_first_name
string
Name of user that created the Agent
created_by_last_name
string
Name of user that created the Agent
created_by_avatar_url
string
Avatar URL of user that created the Agent
name
string
Agent name
description
string
Agent description
category
string
The category of the agent (e.g., dashboard, conversation)
sources
Source[]
Expand Source definition...
model
string
Source model
explore
string
Source explore
has_inaccessible_source
boolean
Has inaccessible source
context
Agent context
Expand Context definition...
instructions
string
Agent instructions
deleted
boolean
Is Agent soft deleted
created_at
string
Agent created_at
updated_at
string
Agent updated_at
content_metadata_id
string
Content metadata ID for this Agent
code_interpreter
boolean
Enables Code Interpreter for this Agent
studio_agent_id
string
Studio Agent ID (if this agent was migrated)

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link