Agents API
Query agent information for your CekatAI workspace.
List Agents
GET/api/agents
Retrieve all agents in your workspace with pagination.
Query Parameters
pageinteger
Page number (default: 1)
limitinteger
Results per page (default: 10)
bash
curl -X GET "https://api.cekat.ai/api/agents" \
-H "Authorization: Bearer YOUR_API_KEY"
Response
200 OK
{
"success": true,
"data": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "John Doe",
"role": "agent",
"email": "[email protected]",
"division": [],
"is_online": true,
"created_at": "2026-04-07T13:28:03.131679"
},
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Jane Smith",
"role": "supervisor",
"email": "[email protected]",
"division": [],
"is_online": true,
"created_at": "2026-03-30T11:50:46.263366"
}
],
"metadata": {
"pagination": {
"total_page": 53,
"total_items": 105,
"current_page": 1
}
}
}
Agent Object
| Field | Type | Description |
|---|---|---|
id | string (UUID) | Unique agent identifier |
name | string | Agent's display name |
role | string | Role: agent or supervisor |
email | string | Agent's email address |
division | array | Array of division IDs |
is_online | boolean | Online status |
created_at | string | Account creation timestamp |
Code Examples
javascript
const getAgents = async (page = 1, limit = 10) => {
const response = await fetch(
`https://api.cekat.ai/api/agents?page=${page}&limit=${limit}`,
{ headers: { 'Authorization': 'Bearer YOUR_API_KEY' } }
);
return response.json();
};
const agents = await getAgents();
// Get online agents
const onlineAgents = agents.data.filter(agent => agent.is_online);
console.log(`Found ${onlineAgents.length} online agents`);
console.log(`Total agents: ${agents.metadata.pagination.total_items}`);