Box Developer Documentation
Log in

AI agent

This resource is used by enpoints in the version 2024.0. For more details, see Box API versioning.

Standard representation of an AI Agent instance.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

string
1234567890

The unique identifier of the AI Agent.

string
ai_agent

The type of agent used to handle queries.

Value is always ai_agent

string
enabled

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

The entity with type and ID [ Group (Base) / User (Base) ] array

List of allowed users or groups.

string (date-time)
2022-01-01T00:00:00Z

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

User (Base) object

The user who created this agent.

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

The icon reference of the AI Agent.

string (date-time)
2022-01-01T00:00:00Z

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

User (Base) object

The user who most recently modified this agent.

string
This is my Agent

The name of the AI Agent.

string
CUSTOM

The provider of the AI Agent.

Response Example

{
  "id": "1234567890",
  "type": "ai_agent",
  "access_state": "enabled",
  "allowed_entities": [
    {
      "id": "11446498",
      "type": "user"
    }
  ],
  "created_at": "2022-01-01T00:00:00Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "icon_reference": "https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg",
  "modified_at": "2022-01-01T00:00:00Z",
  "modified_by": {
    "id": "11446498",
    "type": "user"
  },
  "name": "This is my Agent",
  "origin": "CUSTOM"
}