Website

Community

Cald AI

API Reference

MyCald Dashboard

Support

Get a list of available agents that you can use for the call.

Get Agents

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

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

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

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

The name given to the agent in the MyCald Dashboard

Whether to enable sending of text messages

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.`

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

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`

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

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

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.`

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

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.

apiKeyAuth

Learn how to use Cald AI's API in under 5 minutes

Quickstart

Create an Agent

Get an Agent

Edit an Agent

Delete an Agent

Initiates an outbound AI-based phone call using a specific agent.

Make a Call Using an Agent

List Voices

Clone a voice based on a file containing an audio recording of an existing voice

Clone a Voice

Delete a Voice

Once a phone call has been initiated, you can frequently query this endpoint (for instance, every two seconds) to receive live updates.

Get Call Logs

Buy a Phone Number

Get a list of all phone numbers that you own

Update the details of a specific phone number

Edit Phone Number Settings

Cancel a Phone Number Subscription

Create a List

Get Lists

Get a list of contacts in a specific list

Get a List

Edit a List

Delete a List

Upload Contacts to a List

Get Contacts in a List

Create a Campaign

Get Campaigns

Get information about a specific campaign

Get a Campaign

Get detailed information and results for a specific campaign

Get Campaign Results

Cancel a Campaign

Initiates an outbound AI-based phone call.

Agents

Voices

Calls

Phone Number Management (U.S. Only)

Lists of Contacts

Contacts

Campaigns

Call (Deprecated)

Get Agents

Authorizations

Response