Box Developer Documentation
Log in
Latest version

Get AI agent by agent ID

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

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

Gets an AI Agent using the agent_id parameter.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
1234

The agent id to get.

Query Parameters

string arrayin queryoptional
ask,text_gen,extract

The fields to return in the response.

Response

application/jsonAI agent (Full)

A successful response including the agent.

application/jsonClient error

An unexpected client error.

application/jsonClient error

An unexpected server error.

get
Get AI agent by agent ID
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

TypeScript Gen
await client.aiStudio.getAiAgentById(createdAgent.id, {
  queryParams: {
    fields: ['ask' as string],
  } satisfies GetAiAgentByIdQueryParams,
} satisfies GetAiAgentByIdOptionalsInput);
Python Gen
client.ai_studio.get_ai_agent_by_id(created_agent.id, fields=["ask"])
.NET Gen
await client.AiStudio.GetAiAgentByIdAsync(agentId: createdAgent.Id, queryParams: new GetAiAgentByIdQueryParams() { Fields = Array.AsReadOnly(new [] {"ask"}) });
Swift Gen (Beta)
try await client.aiStudio.getAiAgentById(agentId: createdAgent.id, queryParams: GetAiAgentByIdQueryParams(fields: ["ask"]))
Java Gen (Beta)
client.getAiStudio().getAiAgentById(createdAgent.getId(), new GetAiAgentByIdQueryParams.GetAiAgentByIdQueryParamsBuilder().fields(Arrays.asList("ask")).build())

Response Example

{
  "id": "1234567890",
  "type": "ai_agent",
  "access_state": "enabled",
  "allowed_entities": [
    {
      "id": "11446498",
      "type": "user"
    }
  ],
  "ask": {
    "type": "ai_agent_ask",
    "access_state": "enabled",
    "basic_text": {
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "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"
    },
    "basic_text_multi": {
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "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"
    },
    "custom_instructions": "This is a custom instruction",
    "description": "This is ASK Agent",
    "long_text": {
      "embeddings": {
        "model": "azure__openai__text_embedding_ada_002",
        "strategy": {
          "id": "basic",
          "num_tokens_per_chunk": 64
        }
      },
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "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"
    },
    "long_text_multi": {
      "embeddings": {
        "model": "azure__openai__text_embedding_ada_002",
        "strategy": {
          "id": "basic",
          "num_tokens_per_chunk": 64
        }
      },
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "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"
    }
  },
  "created_at": "2022-01-01T00:00:00Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "extract": {
    "type": "ai_agent_extract",
    "access_state": "enabled",
    "basic_text": {
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "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"
    },
    "custom_instructions": "This is a custom instruction",
    "description": "This is ASK Agent",
    "long_text": {
      "embeddings": {
        "model": "azure__openai__text_embedding_ada_002",
        "strategy": {
          "id": "basic",
          "num_tokens_per_chunk": 64
        }
      },
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "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"
    }
  },
  "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",
  "text_gen": {
    "type": "ai_agent_text_gen",
    "access_state": "enabled",
    "basic_gen": {
      "content_template": "---{content}---",
      "embeddings": {
        "model": "azure__openai__text_embedding_ada_002",
        "strategy": {
          "id": "basic",
          "num_tokens_per_chunk": 64
        }
      },
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "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"
    },
    "custom_instructions": "This is a custom instruction",
    "description": "This is ASK Agent"
  }
}