Box Developer Documentation

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Get agents

Get agents

Box AI Studio is available only for Enterprise Advanced accounts.

List all AI agents

The GET /2.0/ai_agents endpoint allows you to list all AI agents based on the provided parameters.

Send a request

To send a request, use the GET /2.0/ai_agents endpoint.

Make sure you have generated the developer token to authorize your app. See getting started with Box AI Studio for details.

cURL
curl -i -X GET "https://api.box.com/2.0/ai_agents" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.aiStudio.getAiAgents();
Python v10
client.ai_studio.get_ai_agents()
.NET v10
await client.AiStudio.GetAiAgentsAsync();
Swift v10
try await client.aiStudio.getAiAgents()
Java v10
client.getAiStudio().getAiAgents()

Parameters

To make a call, you must pass the following parameters. Mandatory parameters are in bold.

ParameterDescriptionExample
modeThe mode to filter the agent configuration to return. Possible values are: ask, text_gen, and extract.ask
fieldsThe fields to return in the response.ask
agent_stateThe state of the agent to return. Value is one of enabled,disabled.enabled
fieldsThe fields to return in the response. Value is one of ask, text_gen, extract.ask
include_box_defaultWhether to include the Box default agents in the response.true
limitThe maximum number of items to return per page.1000
markerDefines the position marker at which to begin returning results.JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii