Skip to main content
POST
Start a Quick AI Phone Call

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

A UUID. When present, deduplicates repeat submissions. See /api-reference/idempotency.

Body

application/json
to_numbers
string[]
required

Who to reach: phone numbers in any common format (415-555-0123, (415) 555-0123, +14155550123; +1 is assumed when the country code is missing) and/or names of contacts in the workspace (case-insensitive, small typos are fine). Each entry is detected automatically

Required array length: 1 - 20 elements

Phone number in any common format (+1 assumed when missing) or a contact's name

Required string length: 1 - 120
goal
string
required

What the AI should accomplish on the call. Drives the system prompt.

Required string length: 10 - 2000
language
string
default:en
required
Maximum string length: 10
retry_attempts
integer
default:1
required
Required range: 0 <= x <= 5
retry_delay_minutes
integer
default:10
required
Required range: 1 <= x <= 1440
max_call_duration_seconds
integer
default:600
required
Required range: 30 <= x <= 1800
voicemail_enabled
boolean
default:true
required
record
boolean
default:true
required
instructions
string
Maximum string length: 4000
opening_message
string
Maximum string length: 500
voice
string
Maximum string length: 120
voice_model_tier
enum<string>
Available options:
standard,
mini
voicemail_message
string
Maximum string length: 600
contact_name
string
Maximum string length: 120

Response

Success

data
object
required