Create an Agent

cURL

curl --request POST \
  --url https://my.cald.ai/client/api/v1/agents \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "instructions": "<string>",
  "maxCallDuration": 10,
  "recordingSettings": {
    "enable": false
  },
  "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>"
}

POST

agents

cURL

curl --request POST \
  --url https://my.cald.ai/client/api/v1/agents \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "instructions": "<string>",
  "maxCallDuration": 10,
  "recordingSettings": {
    "enable": false
  },
  "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

Authorization

string

header

required

Your API key, e.g. caldLiveDe39a3accb206dd615f30d118e519df0

Body

application/json

name

string

required

The name given to the agent in the MyCald Dashboard

instructions

string

required

The instructions for the agent, for example, Hi, convince the prospect to buy the product

maxCallDuration

number

default:10

The maximum duration of a call in minutes, between 1 and 60

recordingSettings

object

Show child attributes

recordingSettings.enable

boolean

default:false

Whether to enable recording of the calls

greeting

string

The greeting for the agent, for example, Hi there!

transferSettings

object

Show child attributes

transferSettings.enable

boolean

default:false

Whether to enable transfer of the calls

transferSettings.rule

string

default:always

The rule to use for transferring the calls, for example: transfer the call if the prospect would like to have more information or the AI is unable to answer the question

transferSettings.phoneNumber

string

The phone number to transfer the call to

machineSettings

object

Show child attributes

machineSettings.enable

boolean

default:false

Whether to enable machine detection (e.g. IVR, voicemail), where the AI will hang up if it detects a machine

voicemailSettings

object

Show child attributes

voicemailSettings.enable

boolean

default:false

Whether to enable saying a voicemail message if the call is picked up by a voicemail

voicemailSettings.voicemail

string

The message to say, only available if enable is set to true, for example, Hi, this is the AI assistant calling on behalf of John Smith. I was curious if you would be interested in our product. Please call us back at 123-456-7890.

webhookSettings

object

Show child attributes

webhookSettings.enable

boolean

default:false

Whether to enable sending of a webhook to a URL of your choice when the call is completed

webhookSettings.url

string

The webhook needs to be an HTTP or HTTPS callback URL. Upon completion of the call, we'll transmit the call ID, transcript, etc. to this URL. This feature is beneficial for receiving real-time notifications at the conclusion of calls.

smsSettings

object

Show child attributes

smsSettings.enable

boolean

default:false

Whether to enable sending of text messages

smsSettings.rule

string

default:always

The rule to use for sending text messages, for example: send a text message if the prospect is interested in the offer

smsSettings.message

string

The message to send, only available if enable is set to true, for example, Hi, please visit our website at https://www.example.com for more information.`

voice

string

default:standard_male

The voice ID of the voice to use for the agent, for example, standard_male

Response

Success response with agent details

status

string

Whether the agent was successfully created, can be either success or failed

agentId

string

Unique identifier for the agent (only returned if the agent was successfully created)

Get Agents

⌘I

Agents

Voices

Calls

Phone Number Management (U.S. Only)

Lists of Contacts

Contacts

Campaigns

Call (Deprecated)

Create an Agent

Authorizations

Body

Response