Box Developer Documentation

Create agents

Create agents

Box AI Studio is available only for Enterprise Advanced accounts.

The POST/2.0/ai_agents endpoint allows you to create a new, custom AI agent.

Send a request

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

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

Parameters

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

ParameterDescriptionExample
typeThe type of agent used to handle queries.ai_agent
nameThe name of the AI Agent.My AI Agent
access_stateThe state of the AI Agent. Value is one of enabled disabled.enabled
icon_referenceThe icon reference of the AI Agent. It should have format of the URL https://cdn01.boxcdn.net/app-assets/aistudio/avatars/<file_name> , where the possible values of file_name are: logo_boxAi.png,logo_stamp.png, logo_legal.png,logo_finance.png,logo_config.png,logo_handshake.png logo_analytics.png,logo_classification.png.https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg
allowed_entitiesList of allowed users or groups.
askThe AI Agent to be used for ask.ask
extractThe AI Agent to be used for extraction.
text_genThe AI agent used for generating text.