Create agents - Box Dev Docs

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);

client.ai_studio.create_ai_agent(
    agent_name,
    "enabled",
    ask=AiStudioAgentAsk(access_state="enabled", description="desc1"),
)

await client.AiStudio.CreateAiAgentAsync(requestBody: new CreateAiAgent(name: agentName, accessState: "enabled") { Ask = new AiStudioAgentAsk(accessState: "enabled", description: "desc1") });

try await client.aiStudio.createAiAgent(requestBody: CreateAiAgent(name: agentName, accessState: "enabled", ask: AiStudioAgentAsk(accessState: "enabled", description: "desc1")))

client.getAiStudio().createAiAgent(new CreateAiAgent.Builder(agentName, "enabled").ask(new AiStudioAgentAsk("enabled", "desc1")).build())

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.

​Before you start

​Send a request

​Parameters

Before you start

Send a request

Parameters