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.
Parameter | Description | Example |
---|---|---|
type | The type of agent used to handle queries. | ai_agent |
name | The name of the AI Agent. | My AI Agent |
access_state | The state of the AI Agent. Value is one of enabled disabled . | enabled |
icon_reference | The 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_entities | List of allowed users or groups. | |
ask | The AI Agent to be used for ask. | ask |
extract | The AI Agent to be used for extraction. | |
text_gen | The AI agent used for generating text. |