Skip to main content
API version 2024.0 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.
​
id
string
example: 1234567890The unique identifier of the AI Agent.
​
type
string
example: ai_agentThe type of agent used to handle queries.Value is always ai_agent
​
access_state
string
example: enabledThe state of the AI Agent. Possible values are: enabled, disabled, and enabled_for_selected_users.
​
allowed_entities
The entity with type and ID[Group (Base)/User (Base)]array
List of allowed users or groups.
​
created_at
string(date-time)
example: 2022-01-01T00:00:00ZThe ISO date-time formatted timestamp of when this AI agent was created.
​
created_by
User (Base)object
The user who created this agent.
​
icon_reference
string
example: https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svgThe icon reference of the AI Agent.
​
modified_at
string(date-time)
example: 2022-01-01T00:00:00ZThe ISO date-time formatted timestamp of when this AI agent was recently modified.
​
modified_by
User (Base)object
The user who most recently modified this agent.
​
name
string
example: This is my AgentThe name of the AI Agent.
​
origin
string
example: CUSTOMThe provider of the AI Agent.
{
  "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"
}