Get agent
curl --request GET \
--url https://api.omnia-voice.com/api/v1/agents/{id} \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.omnia-voice.com/api/v1/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.omnia-voice.com/api/v1/agents/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "ACTIVE",
"type": "standard",
"workspaceId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"standardConfig": {
"languageId": "<string>",
"voiceId": "<string>",
"basePrompt": "<string>",
"greeting": "<string>",
"context": "<string>",
"questions": "<string>",
"customInstructions": "<string>",
"recordingEnabled": true,
"temperature": 0,
"maxDuration": 3000,
"firstSpeaker": "agent",
"interruptible": false,
"inactivityTimeout": 155,
"inactivityAction": "hang_up",
"model": "llama",
"language": {
"id": "<string>",
"code": "<string>",
"name": "<string>",
"isActive": true
},
"voice": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"previewUrl": "<string>",
"languageCode": "<string>",
"gender": "<string>",
"isActive": true,
"language": {
"code": "<string>",
"name": "<string>"
}
}
},
"actions": [
{}
],
"knowledgeBases": [
{}
]
}{
"error": "Invalid request body",
"details": {
"formErrors": [
"<string>"
],
"fieldErrors": {
"baseUrlPattern": [
"Internal URLs are not allowed"
]
}
}
}Agents
Get agent
Retrieve a specific agent by ID
GET
/
agents
/
{id}
Get agent
curl --request GET \
--url https://api.omnia-voice.com/api/v1/agents/{id} \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.omnia-voice.com/api/v1/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.omnia-voice.com/api/v1/agents/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "ACTIVE",
"type": "standard",
"workspaceId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"standardConfig": {
"languageId": "<string>",
"voiceId": "<string>",
"basePrompt": "<string>",
"greeting": "<string>",
"context": "<string>",
"questions": "<string>",
"customInstructions": "<string>",
"recordingEnabled": true,
"temperature": 0,
"maxDuration": 3000,
"firstSpeaker": "agent",
"interruptible": false,
"inactivityTimeout": 155,
"inactivityAction": "hang_up",
"model": "llama",
"language": {
"id": "<string>",
"code": "<string>",
"name": "<string>",
"isActive": true
},
"voice": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"previewUrl": "<string>",
"languageCode": "<string>",
"gender": "<string>",
"isActive": true,
"language": {
"code": "<string>",
"name": "<string>"
}
}
},
"actions": [
{}
],
"knowledgeBases": [
{}
]
}{
"error": "Invalid request body",
"details": {
"formErrors": [
"<string>"
],
"fieldErrors": {
"baseUrlPattern": [
"Internal URLs are not allowed"
]
}
}
}Authorizations
API key for authentication
Path Parameters
Agent ID
Response
Successful response
An agent as returned by the API.
Note the asymmetry with the create/update payloads: you write
configuration under config, and read it back under
standardConfig (or customProvider). The type field tells you which
one is present.
Only ACTIVE agents accept calls.
Available options:
ACTIVE, INACTIVE, SUSPENDED standard agents carry standardConfig. custom agents use
caller-supplied STT/LLM/TTS providers and carry customProvider.
Available options:
standard, custom The workspace this agent belongs to.
Present when type is standard.
Show child attributes
Show child attributes
Actions attached to this agent.
Knowledge bases attached to this agent.