curl --request GET \
--url https://voice-api.onclarity.com/v1/projects/{projectId}/agents/{id}/versions/{versionId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://voice-api.onclarity.com/v1/projects/{projectId}/agents/{id}/versions/{versionId}"
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/{id}/versions/{versionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "9a8b7c6d-1234-4f56-8a90-abcdef012345",
"agent_id": "3f0c6a52-8d7e-4b8a-9a43-0f2b5c1e9d11",
"version_number": 3,
"status": "published",
"created_at": 1760000000000,
"created_by": "org-token:42",
"first_published_at": 1760000000000,
"published_at": 1760000000000,
"published_by": "org-token:42",
"agent_type": "chained",
"preferred_language": "English (US)",
"greeting_message": "Hi, thanks for calling Acme billing. How can I help?",
"agent_model_config": {
"llm_provider": "openai",
"llm_model": "gpt-6-luna"
},
"tools_snapshot": [
{
"id": "1e2d3c4b-5a69-4788-9a0b-c1d2e3f4a5b6",
"name": "lookup_invoice",
"description": "Look up an invoice by its number.",
"type": "http",
"configs": {},
"parameters": {},
"sort_order": 0
}
],
"dictionaries_snapshot": []
}{
"error": "Invalid or revoked token"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "Version not found"
}Get an agent version
Returns the full configuration of one version (draft, published or outdated), including the tools and dictionaries attached to it as they were when the version was saved.
curl --request GET \
--url https://voice-api.onclarity.com/v1/projects/{projectId}/agents/{id}/versions/{versionId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://voice-api.onclarity.com/v1/projects/{projectId}/agents/{id}/versions/{versionId}"
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/{id}/versions/{versionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "9a8b7c6d-1234-4f56-8a90-abcdef012345",
"agent_id": "3f0c6a52-8d7e-4b8a-9a43-0f2b5c1e9d11",
"version_number": 3,
"status": "published",
"created_at": 1760000000000,
"created_by": "org-token:42",
"first_published_at": 1760000000000,
"published_at": 1760000000000,
"published_by": "org-token:42",
"agent_type": "chained",
"preferred_language": "English (US)",
"greeting_message": "Hi, thanks for calling Acme billing. How can I help?",
"agent_model_config": {
"llm_provider": "openai",
"llm_model": "gpt-6-luna"
},
"tools_snapshot": [
{
"id": "1e2d3c4b-5a69-4788-9a0b-c1d2e3f4a5b6",
"name": "lookup_invoice",
"description": "Look up an invoice by its number.",
"type": "http",
"configs": {},
"parameters": {},
"sort_order": 0
}
],
"dictionaries_snapshot": []
}{
"error": "Invalid or revoked token"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "Version not found"
}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
Agent id
Version id, from GET .../agents/{id}/versions.
Response
The version.
The full configuration of one agent version, with the tools and dictionaries attached to it as they were when the version was saved. Fields not listed here may also be present.
Frozen dictionary definitions bound to this version, sorted by ord.
Show child attributes
Show child attributes
draft, published, outdated Frozen tool definitions bound to this version, sorted by sort_order.
Show child attributes
Show child attributes
x >= 1Frozen Hold Phrase Set definitions bound to this version, sorted by ord.
Show child attributes
Show child attributes
Show child attributes
Show child attributes