POST
/
agents

Authorizations

Authorization
string
header
required

Your API key, e.g. caldLiveDe39a3accb206dd615f30d118e519df0

Body

application/json
greeting
string

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

instructions
string

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

machineSettings
object
maxCallDuration
number
default:
10

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

name
string

The name given to the agent in the MyCald Dashboard

recordingSettings
object
smsSettings
object
transferSettings
object
voice
string
default:
standard_male

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

voicemailSettings
object
webhookSettings
object

Response

200 - application/json
agentId
string

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

status
string

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