Website

Community

Cald AI

API Reference

MyCald Dashboard

Support

Upload Contacts to a List

The email address of the contact, this is optional

The phone number of the individual or business you're calling. - For international numbers, include the country code without extra formatting (such as parentheses or dashes), for example, '+441234567890'. - For U.S. numbers, although formatting is allowed, it's advisable to remove any additional characters for consistency.

The prospectName is the default variable that is always present for all agents. It can be used in your agent scripts on the MyCald Dashboard by typing {prospectName}.

Feel free to add more custom variables to the list, depending on the use case. Once configured in the agent page of the MyCald Dashboard, they will automatically become available in the API

apiKeyAuth

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

Quickstart

Create an Agent

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

Get Agents

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

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)

Upload Contacts to a List

Authorizations

Path Parameters

Body

Response