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.

Standard representation of an AI Agent instance.

​
id
string
required

The unique identifier of the AI Agent.

Example:

"1234567890"

​
origin
string
required

The provider of the AI Agent.

Example:

"CUSTOM"

​
name
string
required

The name of the AI Agent.

Example:

"This is my Agent"

​
access_state
string
required

The state of the AI Agent. Possible values are: enabled, disabled, and enabled_for_selected_users.

Example:

"enabled"

​
type
enum<string>

The type of agent used to handle queries.

Available options:
ai_agent
Example:

"ai_agent"

​
created_by
User (Base) · object

The user who created this agent.

​
created_at
string<date-time>

The ISO date-time formatted timestamp of when this AI agent was created.

Example:

"2022-01-01T00:00:00Z"

​
modified_by
User (Base) · object

The user who most recently modified this agent.

​
modified_at
string<date-time>

The ISO date-time formatted timestamp of when this AI agent was recently modified.

Example:

"2022-01-01T00:00:00Z"

​
icon_reference
string

The icon reference of the AI Agent.

Minimum string length: 1
Example:

"https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg"

​
allowed_entities
(User (Base) · object | Group (Base) · object)[]

List of allowed users or groups.

A mini representation of a user, used when nested within another resource.