Skip to main content
GET
/
ai_agent_default
cURL
curl -L GET "https://api.box.com/2.0/ai_agent_default?mode=text_gen" \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'
{
  "type": "ai_agent_ask",
  "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
      }
    }
  },
  "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}`."
  },
  "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|>"
    }
  },
  "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
      }
    }
  },
  "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}`."
  },
  "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}`."
  },
  "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}`."
  }
}
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
enum<string>
required

The mode to filter the agent config to return.

Available options:
ask,
text_gen,
extract,
extract_structured
​
language
string

The ISO language code to return the agent config for. If the language is not supported the default agent config is returned.

​
model
string

The model to return the default agent config for.

Response

A successful response including the default agent configuration. This response can be one of the following four objects:

  • AI agent for questions
  • AI agent for text generation
  • AI agent for freeform metadata extraction
  • AI agent for structured metadata extraction. The response depends on the agent configuration requested in this endpoint.

The AI agent used to handle queries.

​
type
enum<string>
required

The type of AI agent used to handle queries.

Available options:
ai_agent_ask
Example:

"ai_agent_ask"

​
long_text
AI agent long text tool · object

AI agent processor used to to handle longer text.

​
basic_text
AI agent basic text tool · object

AI agent processor used to handle basic text.

​
spreadsheet
AI agent spreadsheet tool · object

The AI agent tool used to handle spreadsheets and tabular data.

​
long_text_multi
AI agent long text tool · object

AI agent processor used to to handle longer text.

​
basic_text_multi
AI agent basic text tool · object

AI agent processor used to handle basic text.

​
basic_image
AI agent basic text tool · object

AI agent processor used to handle basic text.

​
basic_image_multi
AI agent basic text tool · object

AI agent processor used to handle basic text.