curl
curl --request GET \
--url https://example.algolia.net/agent-studio/1/agents/lorem \
--header 'accept: application/json' \
--header 'x-algolia-api-key: ALGOLIA_API_KEY' \
--header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'// Initialize the client
var client = new AgentStudioClient(
new AgentStudioConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
);
// Call the API
var response = await client.GetAgentAsync("76710f1b-8231-42e5-b0d1-f43aac618e15");
// print the response
Console.WriteLine(response);// Initialize the client
final client = AgentStudioClient(
appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY');
// Call the API
final response = await client.getAgent(
agentId: "76710f1b-8231-42e5-b0d1-f43aac618e15",
);
// print the response
print(response);// Initialize the client
client, err := agentStudio.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
if err != nil {
// The client can fail to initialize if you pass an invalid parameter.
panic(err)
}
// Call the API
response, err := client.GetAgent(client.NewApiGetAgentRequest(
"76710f1b-8231-42e5-b0d1-f43aac618e15"))
if err != nil {
// handle the eventual error
panic(err)
}
// print the response
print(response)// Initialize the client
AgentStudioClient client = new AgentStudioClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");
// Call the API
AgentWithVersionResponse response = client.getAgent("76710f1b-8231-42e5-b0d1-f43aac618e15");
// print the response
System.out.println(response);// Initialize the client
const client = agentStudioClient('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');
// Call the API
const response = await client.getAgent({ agentId: '76710f1b-8231-42e5-b0d1-f43aac618e15' });
// print the response
console.log(response);// Initialize the client
val client = AgentStudioClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")
// Call the API
var response = client.getAgent(agentId = "76710f1b-8231-42e5-b0d1-f43aac618e15")
// print the response
println(response)// Initialize the client
$client = AgentStudioClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');
// Call the API
$response = $client->getAgent(
'76710f1b-8231-42e5-b0d1-f43aac618e15',
);
// print the response
var_dump($response);# Initialize the client
# In an asynchronous context, you can use AgentStudioClient instead, which exposes the exact same methods.
client = AgentStudioClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
# Call the API
response = client.get_agent(
agent_id="76710f1b-8231-42e5-b0d1-f43aac618e15",
)
# print the response
print(response)# Initialize the client
client = Algolia::AgentStudioClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
# Call the API
response = client.get_agent("76710f1b-8231-42e5-b0d1-f43aac618e15")
# print the response
puts(response)// Initialize the client
val client = AgentStudioClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")
// Call the API
val response = Await.result(
client.getAgent(
agentId = "76710f1b-8231-42e5-b0d1-f43aac618e15"
),
Duration(100, "sec")
)
// print the response
println(response)// Initialize the client
let client = try AgentStudioClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")
// Call the API
let response = try await client.getAgent(agentId: "76710f1b-8231-42e5-b0d1-f43aac618e15")
// print the response
print(response){
"config": {},
"createdAt": "<string>",
"description": "<string>",
"id": "<string>",
"instructions": "<string>",
"lastUsedAt": "<string>",
"name": "<string>",
"providerId": "<string>",
"status": "draft",
"updatedAt": "<string>",
"model": "<string>",
"systemPrompt": "<string>",
"templateType": "<string>",
"tools": [
{
"description": "<string>",
"inputSchema": {
"properties": {},
"required": [
"<string>"
],
"type": "object"
},
"name": "<string>",
"type": "client_side",
"isTerminal": false
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Agents
Get Agent
Retrieve details of the specified agent.
GET
/
1
/
agents
/
{agentId}
curl
curl --request GET \
--url https://example.algolia.net/agent-studio/1/agents/lorem \
--header 'accept: application/json' \
--header 'x-algolia-api-key: ALGOLIA_API_KEY' \
--header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'// Initialize the client
var client = new AgentStudioClient(
new AgentStudioConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
);
// Call the API
var response = await client.GetAgentAsync("76710f1b-8231-42e5-b0d1-f43aac618e15");
// print the response
Console.WriteLine(response);// Initialize the client
final client = AgentStudioClient(
appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY');
// Call the API
final response = await client.getAgent(
agentId: "76710f1b-8231-42e5-b0d1-f43aac618e15",
);
// print the response
print(response);// Initialize the client
client, err := agentStudio.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
if err != nil {
// The client can fail to initialize if you pass an invalid parameter.
panic(err)
}
// Call the API
response, err := client.GetAgent(client.NewApiGetAgentRequest(
"76710f1b-8231-42e5-b0d1-f43aac618e15"))
if err != nil {
// handle the eventual error
panic(err)
}
// print the response
print(response)// Initialize the client
AgentStudioClient client = new AgentStudioClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");
// Call the API
AgentWithVersionResponse response = client.getAgent("76710f1b-8231-42e5-b0d1-f43aac618e15");
// print the response
System.out.println(response);// Initialize the client
const client = agentStudioClient('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');
// Call the API
const response = await client.getAgent({ agentId: '76710f1b-8231-42e5-b0d1-f43aac618e15' });
// print the response
console.log(response);// Initialize the client
val client = AgentStudioClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")
// Call the API
var response = client.getAgent(agentId = "76710f1b-8231-42e5-b0d1-f43aac618e15")
// print the response
println(response)// Initialize the client
$client = AgentStudioClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');
// Call the API
$response = $client->getAgent(
'76710f1b-8231-42e5-b0d1-f43aac618e15',
);
// print the response
var_dump($response);# Initialize the client
# In an asynchronous context, you can use AgentStudioClient instead, which exposes the exact same methods.
client = AgentStudioClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
# Call the API
response = client.get_agent(
agent_id="76710f1b-8231-42e5-b0d1-f43aac618e15",
)
# print the response
print(response)# Initialize the client
client = Algolia::AgentStudioClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
# Call the API
response = client.get_agent("76710f1b-8231-42e5-b0d1-f43aac618e15")
# print the response
puts(response)// Initialize the client
val client = AgentStudioClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")
// Call the API
val response = Await.result(
client.getAgent(
agentId = "76710f1b-8231-42e5-b0d1-f43aac618e15"
),
Duration(100, "sec")
)
// print the response
println(response)// Initialize the client
let client = try AgentStudioClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")
// Call the API
let response = try await client.getAgent(agentId: "76710f1b-8231-42e5-b0d1-f43aac618e15")
// print the response
print(response){
"config": {},
"createdAt": "<string>",
"description": "<string>",
"id": "<string>",
"instructions": "<string>",
"lastUsedAt": "<string>",
"name": "<string>",
"providerId": "<string>",
"status": "draft",
"updatedAt": "<string>",
"model": "<string>",
"systemPrompt": "<string>",
"templateType": "<string>",
"tools": [
{
"description": "<string>",
"inputSchema": {
"properties": {},
"required": [
"<string>"
],
"type": "object"
},
"name": "<string>",
"type": "client_side",
"isTerminal": false
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Required ACL:
settingsAuthorizations
Response
Successful Response.
Last modified on October 12, 2026
Was this page helpful?