Create and trigger an AI phone call from a natural language prompt. Generates a workflow, initiates the call, and optionally delivers results to a callback URL.
callback_url, the API will POST call results to that URL when the call completes or fails (including not picked up, busy, voicemail).
Callback delivery is best-effort (single attempt, 30-second timeout). For guaranteed delivery, poll the call status as a fallback.
callback_secret, the callback request includes an Authorization: Bearer <your_secret> header.
call_status | provider_status | Meaning |
|---|---|---|
success | completed | Call completed normally |
not_picked_up | no-answer | No one answered |
not_picked_up | busy | Line was busy |
not_picked_up | failed | Call failed (bad number, carrier error) |
not_picked_up | canceled | Call was canceled |
voicemail | completed | Went to voicemail |
idempotency_key. If the same key is sent within a 5-minute window, the API returns the cached response without creating a new call.
API key generated from Settings → API Keys. Format: ck_live_...
Natural language description of the call task. The system generates an AI workflow from this prompt.
"Book a reservation at Friday 7pm for Josh for 2"
Phone number of the call recipient in E.164 format
"+14155552671"
HTTPS URL to receive call results when the call completes or fails. Must not point to private/reserved IP ranges.
"https://agent.example.com/results"
Optional bearer token included in the Authorization header of callback requests
"my-secret-token"
Optional unique key to prevent duplicate calls on retries. Scoped to your organization with a 5-minute TTL.
"agent-task-12345"