Box Developer Documentation
Log in

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Latest version

List AI agents

get
https://api.box.com/2.0
/ai_agents

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Lists AI agents based on the provided parameters.

Request

bearer [ACCESS_TOKEN]
application/json

Query Parameters

string arrayin queryoptional
enabled

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

string arrayin queryoptional
ask,text_gen,extract

The fields to return in the response.

booleanin queryoptional
true
false

Whether to include the Box default agents in the response.

integer (int64)in queryoptional
1000
1000

The maximum number of items to return per page.

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

Defines the position marker at which to begin returning results.

string arrayin queryoptional
ask,text_gen,extract

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

Response

application/jsonAI agents list

A successful response including the agents list.

application/jsonClient error

An unexpected client error.

application/jsonClient error

An unexpected server error.

get
List AI agents
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


cURL
curl -i -X GET "https://api.box.com/2.0/ai_agents" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.aiStudio.getAiAgents();
Python v10
client.ai_studio.get_ai_agents()
.NET v10
await client.AiStudio.GetAiAgentsAsync();
Swift v10
try await client.aiStudio.getAiAgents()
Java v10
client.getAiStudio().getAiAgents()

Response Example

{
  "entries": [
    {
      "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",
      "id": "1234567890",
      "modified_at": "2022-01-01T00:00:00Z",
      "modified_by": {
        "id": "11446498",
        "type": "user"
      },
      "name": "This is my Agent",
      "origin": "CUSTOM",
      "type": "ai_agent",
      "ask": {
        "access_state": "enabled",
        "basic_image": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "basic_image_multi": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "basic_text": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "basic_text_multi": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "custom_instructions": "This is a custom instruction",
        "description": "This is ASK Agent",
        "long_text": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "embeddings": {
            "model": "azure__openai__text_embedding_ada_002",
            "strategy": {
              "id": "basic",
              "num_tokens_per_chunk": 64
            }
          },
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "long_text_multi": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "embeddings": {
            "model": "azure__openai__text_embedding_ada_002",
            "strategy": {
              "id": "basic",
              "num_tokens_per_chunk": 64
            }
          },
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "spreadsheet": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "suggested_questions": [
          "What is in this file?",
          "What are the main highlights of this document?"
        ],
        "type": "ai_agent_ask"
      },
      "extract": {
        "access_state": "enabled",
        "basic_image": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "basic_text": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "custom_instructions": "This is a custom instruction",
        "description": "This is ASK Agent",
        "long_text": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "embeddings": {
            "model": "azure__openai__text_embedding_ada_002",
            "strategy": {
              "id": "basic",
              "num_tokens_per_chunk": 64
            }
          },
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "type": "ai_agent_extract"
      },
      "text_gen": {
        "access_state": "enabled",
        "basic_gen": {
          "llm_endpoint_params": {
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1,
            "type": "openai_params"
          },
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "prompt_template": "It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`",
          "system_message": "You are a helpful travel assistant specialized in budget travel",
          "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"
          ]
        },
        "custom_instructions": "This is a custom instruction",
        "description": "This is ASK Agent",
        "suggested_questions": [
          "What is in this file?",
          "What are the main highlights of this document?"
        ],
        "type": "ai_agent_text_gen"
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}