curl "https://api.ringyo.ai/v1/agents?limit=10&status=active" \
-H "Authorization: Bearer YOUR_API_KEY"
const params = new URLSearchParams({
limit: '10',
status: 'active',
});
const response = await fetch(
`https://api.ringyo.ai/v1/agents?${params}`,
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
},
}
);
const { data, has_more } = await response.json();
import requests
response = requests.get(
'https://api.ringyo.ai/v1/agents',
headers={'Authorization': 'Bearer YOUR_API_KEY'},
params={
'limit': 10,
'status': 'active'
}
)
data = response.json()
agents = data['data']
{
"data": [
{
"id": "agent_abc123",
"name": "Sales Assistant",
"voice_id": "sarah-professional",
"language": "en-US",
"model": "gpt-4o",
"status": "active",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-18T14:22:00Z"
},
{
"id": "agent_def456",
"name": "Support Agent",
"voice_id": "michael-friendly",
"language": "en-US",
"model": "gpt-4o-mini",
"status": "active",
"created_at": "2024-01-10T08:15:00Z",
"updated_at": "2024-01-10T08:15:00Z"
}
],
"has_more": false,
"next_cursor": null,
"total": 2
}
Agents
List Agents
List all agents in your account
GET
/
v1
/
agents
curl "https://api.ringyo.ai/v1/agents?limit=10&status=active" \
-H "Authorization: Bearer YOUR_API_KEY"
const params = new URLSearchParams({
limit: '10',
status: 'active',
});
const response = await fetch(
`https://api.ringyo.ai/v1/agents?${params}`,
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
},
}
);
const { data, has_more } = await response.json();
import requests
response = requests.get(
'https://api.ringyo.ai/v1/agents',
headers={'Authorization': 'Bearer YOUR_API_KEY'},
params={
'limit': 10,
'status': 'active'
}
)
data = response.json()
agents = data['data']
{
"data": [
{
"id": "agent_abc123",
"name": "Sales Assistant",
"voice_id": "sarah-professional",
"language": "en-US",
"model": "gpt-4o",
"status": "active",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-18T14:22:00Z"
},
{
"id": "agent_def456",
"name": "Support Agent",
"voice_id": "michael-friendly",
"language": "en-US",
"model": "gpt-4o-mini",
"status": "active",
"created_at": "2024-01-10T08:15:00Z",
"updated_at": "2024-01-10T08:15:00Z"
}
],
"has_more": false,
"next_cursor": null,
"total": 2
}
Request
Retrieve a paginated list of all AI voice agents in your account.Headers
string
required
Bearer token for authentication. Format:
Bearer YOUR_API_KEYQuery Parameters
integer
default:"20"
Number of agents to return (1-100)
string
Pagination cursor from a previous response
string
Filter by status:
active or inactivestring
Search agents by name
string
default:"desc"
Sort order:
asc or desc (by created_at)Response
array
Array of agent objects
boolean
Whether there are more results available
string
Cursor for fetching the next page
integer
Total number of agents matching the filter
curl "https://api.ringyo.ai/v1/agents?limit=10&status=active" \
-H "Authorization: Bearer YOUR_API_KEY"
const params = new URLSearchParams({
limit: '10',
status: 'active',
});
const response = await fetch(
`https://api.ringyo.ai/v1/agents?${params}`,
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
},
}
);
const { data, has_more } = await response.json();
import requests
response = requests.get(
'https://api.ringyo.ai/v1/agents',
headers={'Authorization': 'Bearer YOUR_API_KEY'},
params={
'limit': 10,
'status': 'active'
}
)
data = response.json()
agents = data['data']
{
"data": [
{
"id": "agent_abc123",
"name": "Sales Assistant",
"voice_id": "sarah-professional",
"language": "en-US",
"model": "gpt-4o",
"status": "active",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-18T14:22:00Z"
},
{
"id": "agent_def456",
"name": "Support Agent",
"voice_id": "michael-friendly",
"language": "en-US",
"model": "gpt-4o-mini",
"status": "active",
"created_at": "2024-01-10T08:15:00Z",
"updated_at": "2024-01-10T08:15:00Z"
}
],
"has_more": false,
"next_cursor": null,
"total": 2
}
Error Codes
| Code | Description |
|---|---|
invalid_cursor | The pagination cursor is invalid or expired |
invalid_status | Status must be ‘active’ or ‘inactive’ |