Latest version
List AI agents
API version 2024.0
Lists AI agents based on the provided parameters.
Request
bearer [ACCESS_TOKEN]
application/json
Query Parameters
string arrayin queryoptional
enabledThe state of the agents to return. Possible values are: enabled, disabled and enabled_for_selected_users.
string arrayin queryoptional
ask,text_gen,extractThe fields to return in the response.
booleanin queryoptional
truefalseWhether to include the Box default agents in the response.
integer (int64)in queryoptional
10001000The maximum number of items to return per page.
stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioViiDefines the position marker at which to begin returning results.
string arrayin queryoptional
ask,text_gen,extractThe 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.
Request Example
cURL
curl -i -X GET "https://api.box.com/2.0/ai_agents" \
-H "authorization: Bearer <ACCESS_TOKEN>"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_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
},
"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
},
"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
},
"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
},
"type": "ai_agent_ask"
},
"extract": {
"access_state": "enabled",
"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
},
"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
},
"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
},
"custom_instructions": "This is a custom instruction",
"description": "This is ASK Agent",
"type": "ai_agent_text_gen"
}
}
],
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}