Get Agent by ID
curl --request GET \
--url https://agent-prod.studio.lyzr.ai/v2/agent/{agent_id} \
--header 'x-api-key: <api-key>'import requests
url = "https://agent-prod.studio.lyzr.ai/v2/agent/{agent_id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://agent-prod.studio.lyzr.ai/v2/agent/{agent_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://agent-prod.studio.lyzr.ai/v2/agent/{agent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://agent-prod.studio.lyzr.ai/v2/agent/{agent_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://agent-prod.studio.lyzr.ai/v2/agent/{agent_id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://agent-prod.studio.lyzr.ai/v2/agent/{agent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "67e3aff94c4db47d2999cdef",
"name": "Sample Agent",
"description": "This is an example agent response"
}Agents
Get Agent by ID Endpoint
Retrieve agent details using the agent ID.
GET
/
agent
/
{agent_id}
Get Agent by ID
curl --request GET \
--url https://agent-prod.studio.lyzr.ai/v2/agent/{agent_id} \
--header 'x-api-key: <api-key>'import requests
url = "https://agent-prod.studio.lyzr.ai/v2/agent/{agent_id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://agent-prod.studio.lyzr.ai/v2/agent/{agent_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://agent-prod.studio.lyzr.ai/v2/agent/{agent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://agent-prod.studio.lyzr.ai/v2/agent/{agent_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://agent-prod.studio.lyzr.ai/v2/agent/{agent_id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://agent-prod.studio.lyzr.ai/v2/agent/{agent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "67e3aff94c4db47d2999cdef",
"name": "Sample Agent",
"description": "This is an example agent response"
}Endpoint
GET/v3/agents/{agent_id}
Authentication
- Requires an API key (
x-api-key) in the request headers.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
agent_id | string | Unique identifier of the agent to retrieve. |
Request Example (cURL)
curl -X GET "https://agent-prod.studio.lyzr.ai/v3/agents/{agent_id}"
-H "accept: application/json" ^
-H "x-api-key: sk-default-REPLACED-API-KEY"
Response Example
{
"agent_id": "67e21aecd0da0fb69fe95780",
"name": "Finance Advisor",
"description": "Personalized Financial Planning Assistant",
"model": "gpt-4o-mini",
"provider_id": "OpenAI",
"features": [...]
}
⌘I