Sample - Box Platform API
GET/ai_agents

List AI agents

Lists AI agents with optional filters for mode, returned fields, agent state, and whether Box default agents are included. Use marker and limit to navigate the marker-based results, and set include_box_default to include the default agents. Results include agent entries and pagination markers.

6 parameters
modearray<string>optional
Filter agents by mode using `ask`, `text_gen`, or `extract`.
fieldsarray<string>optional
The fields to include in each returned agent.
agent_statearray<string>optional
Filter agents by state: `enabled`, `disabled`, or `enabled_for_selected_users`.
include_box_defaultbooleanoptional
Whether to include Box default agents. Defaults to false when omitted.
Default:false
markerstringoptional
The position marker from which to begin returning agents.
limitintegeroptional
The maximum number of agents to return per page. Must not exceed 1000.

3 status codes
200Returns a paginated list containing AI agent entries and marker-based pagination metadata.
limitintegeroptional
The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.
next_markerstringoptional
The marker for the start of the next page of results.
prev_markerstringoptional
The marker for the start of the previous page of results.
entriesarray<AIAgentFull>required
The list of AI Agents.
400Returned when a client-supplied filter, marker, or limit is invalid.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
500Returned when an unexpected server error occurs.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

limit must not exceed 1000, and filter values should use the documented mode values ask, text_gen, or extract and agent states enabled, disabled, or enabled_for_selected_users. A 400 is returned for an invalid client request, and a 500 is returned for an unexpected server error.