Get Agents by API Key
curl --request GET \
--url https://agent-prod.studio.lyzr.ai/v3/agents/ \
--header 'x-api-key: <api-key>'import requests
url = "https://agent-prod.studio.lyzr.ai/v3/agents/"
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/v3/agents/', 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/v3/agents/",
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/v3/agents/"
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/v3/agents/")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://agent-prod.studio.lyzr.ai/v3/agents/")
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{
"agents": [
{
"id": "12345",
"name": "Finance Advisor",
"description": "Personalized Financial Planning Assistant"
}
]
}Agents
Get Agents By API Key
Retrieves all agents associated with a given API key. This is useful for managing multiple agents and checking their configurations.
GET
/
agents
/
Get Agents by API Key
curl --request GET \
--url https://agent-prod.studio.lyzr.ai/v3/agents/ \
--header 'x-api-key: <api-key>'import requests
url = "https://agent-prod.studio.lyzr.ai/v3/agents/"
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/v3/agents/', 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/v3/agents/",
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/v3/agents/"
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/v3/agents/")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://agent-prod.studio.lyzr.ai/v3/agents/")
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{
"agents": [
{
"id": "12345",
"name": "Finance Advisor",
"description": "Personalized Financial Planning Assistant"
}
]
}Endpoint:
GET/v3/agents/
Request Headers:
| Header | Type | Required | Description |
|---|---|---|---|
| x-api-key | String | Yes | API key for authentication |
| accept | String | Yes | Expected response format (application/json) |
Request Example (cURL):
curl -X GET "https://agent-prod.studio.lyzr.ai/v3/agents/" ^
-H "accept: application/json" ^
-H "x-api-key: sk-default-XXXXXXX"
Request Example (Python):
import requests
url = "https://agent-prod.studio.lyzr.ai/v3/agents/"
headers = {
"accept": "application/json",
"x-api-key": "sk-default-XXXXXXX"
}
response = requests.get(url, headers=headers)
print(response.status_code)
print(response.json()) # Print response data
Response:
{
"agents": [
{
"id": "12345",
"name": "Finance Advisor",
"description": "Personalized Financial Planning Assistant"
}
]
}
⌘I