Skip to main content

Trigger AI Phone Call

Initiate an AI-powered phone call by providing a phone number.
The API automatically creates a contact record if one doesn’t exist, or you can reference an existing contact.

Request Fields

string
required
Phone number to call. We automatically search for any existing contact with this number to avoid creating duplicates.
string
Contact’s first name (used when creating or updating the contact)
string
Contact’s last name (used when creating or updating the contact)
string
Contact’s email address (used when creating or updating the contact)
string (UUID)
Explicitly link the call to a specific contact. This is useful when calling a contact at a different number than their default one—the numberToCall is still dialed, but the call is associated with the specified contact. If the UUID doesn’t exist, we’ll fall back to searching by phone number and create a new contact.
string (UUID)
Customize how the AI behaves during the call using your prompt templates from the Levers app. If not specified, the default template will be used.
object
Optional field for sending extra payload data with the call. This metadata will be included in webhook responses as requestMetadata, allowing you to track additional context like project_id, extra_id, or any custom key-value pairs relevant to your application.
object
Optional key-value pairs for template variable substitution in the system prompt. Each key maps to a placeholder in your prompt template (e.g., {{amount}}), and the value replaces it before the call starts. Only string values are supported.This is separate from metadatametadata is stored on the call log and included in webhooks, while promptTags is consumed at call time to populate the system prompt.
boolean
default:"false"
When true, if an existing contact is found with the provided numberToCall, their firstName, lastName, and email will be updated with the provided values. If no contact is found with that phone number, a new contact will be created with the provided details.