Skip to main content
GET
/
ai_agents
cURL
curl -i -X GET "https://api.box.com/2.0/ai_agents" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "entries": [
    {
      "id": "1234567890",
      "origin": "CUSTOM",
      "name": "This is my Agent",
      "access_state": "enabled",
      "type": "ai_agent",
      "created_by": {
        "id": "11446498",
        "type": "user"
      },
      "created_at": "2022-01-01T00:00:00Z",
      "modified_by": {
        "id": "11446498",
        "type": "user"
      },
      "modified_at": "2022-01-01T00:00:00Z",
      "icon_reference": "https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg",
      "allowed_entities": [
        {
          "id": "11446498",
          "type": "user"
        }
      ],
      "ask": {
        "type": "ai_agent_ask",
        "access_state": "enabled",
        "description": "This is ASK Agent",
        "custom_instructions": "This is a custom instruction",
        "suggested_questions": [
          "What is in this file?",
          "What are the main highlights of this document?"
        ],
        "long_text": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "top_p": 1,
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>"
          },
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "embeddings": {
            "model": "azure__openai__text_embedding_ada_002",
            "strategy": {
              "id": "basic",
              "num_tokens_per_chunk": 64
            }
          },
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "basic_text": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "top_p": 1,
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>"
          },
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "basic_image": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "top_p": 1,
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>"
          },
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "spreadsheet": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "top_p": 1,
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>"
          },
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "long_text_multi": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "top_p": 1,
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>"
          },
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "embeddings": {
            "model": "azure__openai__text_embedding_ada_002",
            "strategy": {
              "id": "basic",
              "num_tokens_per_chunk": 64
            }
          },
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "basic_text_multi": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "top_p": 1,
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>"
          },
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "basic_image_multi": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "top_p": 1,
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>"
          },
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        }
      },
      "text_gen": {
        "type": "ai_agent_text_gen",
        "access_state": "enabled",
        "description": "This is ASK Agent",
        "custom_instructions": "This is a custom instruction",
        "suggested_questions": [
          "What is in this file?",
          "What are the main highlights of this document?"
        ],
        "basic_gen": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "top_p": 1,
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>"
          },
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "prompt_template": "It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`",
          "embeddings": {
            "model": "azure__openai__text_embedding_ada_002",
            "strategy": {
              "id": "basic",
              "num_tokens_per_chunk": 64
            }
          },
          "content_template": "---{content}---",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        }
      },
      "extract": {
        "type": "ai_agent_extract",
        "access_state": "enabled",
        "description": "This is ASK Agent",
        "custom_instructions": "This is a custom instruction",
        "long_text": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "top_p": 1,
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>"
          },
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "embeddings": {
            "model": "azure__openai__text_embedding_ada_002",
            "strategy": {
              "id": "basic",
              "num_tokens_per_chunk": 64
            }
          },
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "basic_text": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "top_p": 1,
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>"
          },
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "basic_image": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "top_p": 1,
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>"
          },
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        }
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
mode
string[]

The mode to filter the agent config to return. Possible values are: ask, text_gen, and extract.

​
fields
string[]

The fields to return in the response.

​
agent_state
string[]

The state of the agents to return. Possible values are: enabled, disabled and enabled_for_selected_users.

​
include_box_default
boolean
default:false

Whether to include the Box default agents in the response.

​
marker
string

Defines the position marker at which to begin returning results.

​
limit
integer<int64>

The maximum number of items to return per page.

Required range: x <= 1000

Response

A successful response including the agents list.

List of AI Agents with pagination.

​
entries
AI agent (Full) · object[]
required

The list of AI Agents.

​
limit
integer<int64>

The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.

Example:

1000

​
next_marker
string | null

The marker for the start of the next page of results.

Example:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"

​
prev_marker
string | null

The marker for the start of the previous page of results.

Example:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"