v1

latestOpenAPI 3.0.02026-08-063524105.9 KB
Calls

Initiate outbound call

Initiate an outbound voice call to the specified phone number using the configured agent. Returns a call ID immediately for tracking. The call is placed asynchronously - use the conversations endpoint to retrieve call results once the call completes. Rate limited to 10 requests per minute.

post/v1/call

Request body

agentIdstring uuid required

UUID of the agent to use for the call

phoneNumberstring required

Phone number to call in E.164 format

variablesobject

Custom variables to pass to the assistant. These override contact field values.

Example request

{
  "agentId": "123e4567-e89b-12d3-a456-426614174000",
  "phoneNumber": "+14155551234",
  "variables": {
    "customerName": "John Doe",
    "appointmentTime": "3pm"
  }
}

Response

Call initiated successfully. Returns call ID for tracking.

callIdstring required

Call identifier for tracking. Use this ID to query call status and results.

Example response

{
  "callId": "vapi-call-abc123"
}