POST
/
v1
/
calls
Initiate a call
curl --request POST \
  --url https://api.air.ai/v1/calls \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "promptId": 123,
  "phone": "<string>",
  "name": "<string>",
  "metadata": "<any>"
}'
{
  "status": "OK"
}

Request

Authentication

Authorization
string
required
Bearer authentication token.
promptId
integer
default:"1"
required
The prompt id of your Agent. This is the 5-6 digit number in the url when you have your agent open.
phone
string
default:"string"
required
The phone number you want to dial.
name
string
default:"string"
required
The name of the lead you want to dial.
metadata
json
default:"{}"
required
Metadata you want to use on your call with the lead.

Response

200
{
  "status": "OK"
}