Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

Box AI Studio is available only for Enterprise Advanced accounts.
The POST /2.0/ai_agents endpoint creates a new custom with configurable capabilities for asking questions, generating text, or extracting metadata.

​
Before you start

Make sure you have completed the steps in to create a platform app and generate a developer token.

​
Send a request

await client.aiStudio.createAiAgent({
  name: agentName,
  accessState: 'enabled',
  ask: new AiStudioAgentAsk({ accessState: 'enabled', description: 'desc1' }),
} satisfies CreateAiAgentInput);

​
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.