Agents
Get Agents
Get a list of available agents that you can use for the call.
GET
/
agents
Copy
curl --request GET \
--url https://my.cald.ai/client/api/v1/agents \
--header 'Authorization: <api-key>'
Copy
{
"agents": [
{
"name": "<string>",
"maxCallDuration": 10,
"recordingSettings": {
"enable": false
},
"instructions": "<string>",
"greeting": "<string>",
"transferSettings": {
"enable": false,
"rule": "always",
"phoneNumber": "<string>"
},
"machineSettings": {
"enable": false
},
"voicemailSettings": {
"enable": false,
"voicemail": "<string>"
},
"webhookSettings": {
"enable": false,
"url": "<string>"
},
"smsSettings": {
"enable": false,
"rule": "always",
"message": "<string>"
},
"voice": "standard_male",
"agentId": "<string>"
}
]
}
Authorizations
Your API key, e.g. caldLiveDe39a3accb206dd615f30d118e519df0
Response
200 - application/json
List of available agents
The response is of type object
.
Copy
curl --request GET \
--url https://my.cald.ai/client/api/v1/agents \
--header 'Authorization: <api-key>'
Copy
{
"agents": [
{
"name": "<string>",
"maxCallDuration": 10,
"recordingSettings": {
"enable": false
},
"instructions": "<string>",
"greeting": "<string>",
"transferSettings": {
"enable": false,
"rule": "always",
"phoneNumber": "<string>"
},
"machineSettings": {
"enable": false
},
"voicemailSettings": {
"enable": false,
"voicemail": "<string>"
},
"webhookSettings": {
"enable": false,
"url": "<string>"
},
"smsSettings": {
"enable": false,
"rule": "always",
"message": "<string>"
},
"voice": "standard_male",
"agentId": "<string>"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.