List agents

Returns a list of your agents and their metadata.

Headers

xi-api-keystringOptional

Query parameters

page_sizeintegerOptional1-100Defaults to 30
How many Agents to return at maximum. Can not exceed 100, defaults to 30.
searchstringOptional
Search by agents name.
archivedbooleanOptional
Filter agents by archived status
show_only_owned_agentsbooleanOptionalDefaults to falseDeprecated

If set to true, the endpoint will omit any agents that were shared with you by someone else and include only the ones you own. Deprecated: use created_by_user_id instead.

created_by_user_idstringOptional

Filter agents by creator user ID. When set, only agents created by this user are returned. Takes precedence over show_only_owned_agents. Use ‘@me’ to refer to the authenticated user.

sort_directionenumOptional
The direction to sort the results
Allowed values:
sort_byenumOptional
The field to sort the results by
Allowed values:
cursorstringOptional
Used for fetching next page. Cursor is returned in the response.

Response

Successful Response
agentslist of objects
A list of agents and their metadata
has_moreboolean
Whether there are more agents to paginate through
next_cursorstring
The next cursor to paginate through the agents

Errors

422
Agents List Request Unprocessable Entity Error