List agents
curl --request GET \
--url https://voice-api.onclarity.com/v1/projects/{projectId}/agents \
--header 'Authorization: Bearer <token>'import requests
url = "https://voice-api.onclarity.com/v1/projects/{projectId}/agents"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://voice-api.onclarity.com/v1/projects/{projectId}/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"agents": [
{
"id": "3f0c6a52-8d7e-4b8a-9a43-0f2b5c1e9d11",
"name": "Billing assistant",
"project_id": "7b1d2e44-51c0-4f3a-8e5b-2a9c0d6f1e33",
"agent_type": "chained",
"preferred_language": "English (US)",
"created_at": 1760000000000,
"updated_at": 1760086400000,
"published_version_id": "9a8b7c6d-1234-4f56-8a90-abcdef012345",
"published_version_number": 3,
"has_draft": false,
"draft_catalog_sync_only": false
}
]
}{
"error": "Invalid or revoked token"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "Project not found"
}{
"error": "name: String must contain at least 1 character(s)",
"issues": [
{
"path": "name",
"code": "too_small",
"message": "String must contain at least 1 character(s)",
"minimum": 1
}
]
}Agents
List agents
Returns the project’s agents with their version status: the live (published) version number, and whether an unpublished draft is pending. Voice Assist agents are left out unless you ask for them with type. List items are a summary; read one agent for its full, current configuration.
GET
/
v1
/
projects
/
{projectId}
/
agents
List agents
curl --request GET \
--url https://voice-api.onclarity.com/v1/projects/{projectId}/agents \
--header 'Authorization: Bearer <token>'import requests
url = "https://voice-api.onclarity.com/v1/projects/{projectId}/agents"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://voice-api.onclarity.com/v1/projects/{projectId}/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"agents": [
{
"id": "3f0c6a52-8d7e-4b8a-9a43-0f2b5c1e9d11",
"name": "Billing assistant",
"project_id": "7b1d2e44-51c0-4f3a-8e5b-2a9c0d6f1e33",
"agent_type": "chained",
"preferred_language": "English (US)",
"created_at": 1760000000000,
"updated_at": 1760086400000,
"published_version_id": "9a8b7c6d-1234-4f56-8a90-abcdef012345",
"published_version_number": 3,
"has_draft": false,
"draft_catalog_sync_only": false
}
]
}{
"error": "Invalid or revoked token"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "Project not found"
}{
"error": "name: String must contain at least 1 character(s)",
"issues": [
{
"path": "name",
"code": "too_small",
"message": "String must contain at least 1 character(s)",
"minimum": 1
}
]
}Authorizations
Your organization API key (it starts with anek_org_). The same key works on the Voice API and the Support API. See Authentication.
Path Parameters
Project id
Query Parameters
assist returns only Voice Assist agents; all returns every type. Omit it to get the voice agents (chained and realtime). Any other value is refused with 422.
Available options:
assist, all Response
The project's agents.
Show child attributes
Show child attributes