Get AI agent by ID
Get AI agent by ID
The GET /2.0/ai_agents/{id} endpoint allows you to list a specific AI
agent by the agent_id parameter.
Send a request
To send a request, use the GET /2.0/ai_agents/{id} endpoint.
cURL
curl -i -X GET "https://api.box.com/2.0/ai_agents/1234567890" \
-H "authorization: Bearer <ACCESS_TOKEN>"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())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 |