Get AI agent by ID

Retrieve a specific AI agent’s configuration using the Box AI Studio API.

Box AI Studio is available only for Enterprise Advanced accounts.

The GET /2.0/ai_agents/{id} endpoint returns the configuration for a specific AI agent.

Before you start

Make sure you have completed the steps in to create a platform app and generate a developer token.

Send a request

cURL

curl -i -X GET "https://api.box.com/2.0/ai_agents/1234567890" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

await client.aiStudio.getAiAgentById(createdAgent.id, {
  queryParams: { fields: ['ask'] } satisfies GetAiAgentByIdQueryParams,
} satisfies GetAiAgentByIdOptionalsInput);

client.ai_studio.get_ai_agent_by_id(created_agent.id, fields=["ask"])

await client.AiStudio.GetAiAgentByIdAsync(agentId: createdAgent.Id, queryParams: new GetAiAgentByIdQueryParams() { Fields = Array.AsReadOnly(new [] {"ask"}) });

try await client.aiStudio.getAiAgentById(agentId: createdAgent.id, queryParams: GetAiAgentByIdQueryParams(fields: ["ask"]))

client.getAiStudio().getAiAgentById(createdAgent.getId(), new GetAiAgentByIdQueryParams.Builder().fields(Arrays.asList("ask")).build())

Parameters

To make a call, you must pass the following parameters. Mandatory parameters are in bold.

Parameter	Description	Example
agent_id	The agent id to get.	1234
fields	The fields to return in the response.	ask