List agents
curl --request GET \
--url https://api-eg.olimi.ai/api/v2/agents \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api-eg.olimi.ai/api/v2/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://api-eg.olimi.ai/api/v2/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://api-eg.olimi.ai/api/v2/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://api-eg.olimi.ai/api/v2/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://api-eg.olimi.ai/api/v2/agents")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-eg.olimi.ai/api/v2/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{
"message": "Agents fetched successfully",
"meta": {
"totalItems": 12,
"itemCount": 10,
"itemsPerPage": 10,
"totalPages": 2,
"currentPage": 1
},
"data": [
{
"id": "0d6a3f7e-5b8c-4b1e-9a51-2f1d7c9e4a10",
"organizationId": "5f2c8a91-7d3e-4b60-8c1a-9e4f2b7d6a35",
"name": "Admissions Assistant",
"description": "Answers questions about enrollment and fees.",
"callType": "inbound",
"isActive": true,
"languageId": "a3b9e2d4-6c1f-4e8a-9d72-1b5c8f3e0a46",
"voiceId": "e7d1c5b2-4a8f-4396-b0e2-7c9a1d3f5b68",
"voice": {
"id": "e7d1c5b2-4a8f-4396-b0e2-7c9a1d3f5b68",
"name": "Salma",
"gender": "female",
"language": {
"id": "a3b9e2d4-6c1f-4e8a-9d72-1b5c8f3e0a46",
"name": "Arabic - Egyptian",
"code": "ar-EG"
}
},
"createdAt": "2026-08-12T09:31:04.112Z",
"updatedAt": "2026-09-20T14:02:51.870Z"
}
]
}{
"statusCode": 404,
"errorCode": "agent_not_found",
"message": "Agent not found"
}{
"statusCode": 422,
"message": [
"name must be shorter than or equal to 100 characters"
],
"error": "Unprocessable Entity"
}Agents
List agents
Returns your agents, newest first, one page at a time.
GET
/
api
/
v2
/
agents
List agents
curl --request GET \
--url https://api-eg.olimi.ai/api/v2/agents \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api-eg.olimi.ai/api/v2/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://api-eg.olimi.ai/api/v2/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://api-eg.olimi.ai/api/v2/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://api-eg.olimi.ai/api/v2/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://api-eg.olimi.ai/api/v2/agents")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-eg.olimi.ai/api/v2/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{
"message": "Agents fetched successfully",
"meta": {
"totalItems": 12,
"itemCount": 10,
"itemsPerPage": 10,
"totalPages": 2,
"currentPage": 1
},
"data": [
{
"id": "0d6a3f7e-5b8c-4b1e-9a51-2f1d7c9e4a10",
"organizationId": "5f2c8a91-7d3e-4b60-8c1a-9e4f2b7d6a35",
"name": "Admissions Assistant",
"description": "Answers questions about enrollment and fees.",
"callType": "inbound",
"isActive": true,
"languageId": "a3b9e2d4-6c1f-4e8a-9d72-1b5c8f3e0a46",
"voiceId": "e7d1c5b2-4a8f-4396-b0e2-7c9a1d3f5b68",
"voice": {
"id": "e7d1c5b2-4a8f-4396-b0e2-7c9a1d3f5b68",
"name": "Salma",
"gender": "female",
"language": {
"id": "a3b9e2d4-6c1f-4e8a-9d72-1b5c8f3e0a46",
"name": "Arabic - Egyptian",
"code": "ar-EG"
}
},
"createdAt": "2026-08-12T09:31:04.112Z",
"updatedAt": "2026-09-20T14:02:51.870Z"
}
]
}{
"statusCode": 404,
"errorCode": "agent_not_found",
"message": "Agent not found"
}{
"statusCode": 422,
"message": [
"name must be shorter than or equal to 100 characters"
],
"error": "Unprocessable Entity"
}Each agent has the fields described in Agent fields.
Use
meta.totalPages to know when you’ve fetched every page.Authorizations
Query Parameters
Page number, starting at 1.
Required range:
x >= 1Agents per page.
Required range:
x >= 1Matches agents whose name or description contains the text. Not case-sensitive.