Agents
Get an Agent
Agents
Get an Agent
Get information about a specific agent
GET
/
agents
/
{agentId}
curl --request GET \
--url https://my.cald.ai/client/api/v1/agents/{agentId} \
--header 'Authorization: <api-key>'
{
"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
Path Parameters
The agent ID of the agent
Response
200
application/json
Agent information
The response is of type object
.
curl --request GET \
--url https://my.cald.ai/client/api/v1/agents/{agentId} \
--header 'Authorization: <api-key>'
{
"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>"
}