POST
/
v1
/
calls
curl --request POST \
  --url https://app.luly.ai/api/v1/calls \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "phone_number": "<string>",
  "pathway_id": "<string>"
}'
{
  "status": "success",
  "call_id": "9d404c1b-6a23-4426-953a-a52c392ff8f1"
}

​
Headers

​
authorization
string
required

Your API key for authentication.

​
Body

​
phone_number
string
required

The phone number to call. Country code defaults to +1 (US) if not specified.

Formatting is flexible, however for the most predictable results use the E.164 format.

​
pathway_id
string
required

Follows the conversational pathway you created to guide the conversation.

You can access your pathway_id by clicking on the ‘Copy ID’ button on your pathways here. If you don’t have any pathways, click the ‘Create Pathway’ button to create one!

​
Response

​
status
string

Can be success or error.

​
call_id
string

A unique identifier for the call (present only if status is success).

{
  "status": "success",
  "call_id": "9d404c1b-6a23-4426-953a-a52c392ff8f1"
}