Agents
Create an Agent
Agents
Create an Agent
Create a new agent
POST
/
agents
curl --request POST \
--url https://my.cald.ai/client/api/v1/agents \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"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"
}'
{
"status": "<string>",
"agentId": "<string>"
}
Authorizations
Your API key, e.g. caldLiveDe39a3accb206dd615f30d118e519df0
Body
application/json
Response
200
application/json
Success response with agent details
The response is of type object
.
curl --request POST \
--url https://my.cald.ai/client/api/v1/agents \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"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"
}'
{
"status": "<string>",
"agentId": "<string>"
}