Skip to main content
POST
v1
/
calls
Send Call (Simple)
curl --request POST \
  --url https://app.luly.ai/api/v1/calls \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '
{
  "phone_number": "<string>",
  "task": "<string>"
}
'
import requests

url = "https://app.luly.ai/api/v1/calls"

payload = {
"phone_number": "<string>",
"task": "<string>"
}
headers = {
"authorization": "<authorization>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({phone_number: '<string>', task: '<string>'})
};

fetch('https://app.luly.ai/api/v1/calls', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://app.luly.ai/api/v1/calls",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'phone_number' => '<string>',
'task' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <authorization>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://app.luly.ai/api/v1/calls"

payload := strings.NewReader("{\n \"phone_number\": \"<string>\",\n \"task\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://app.luly.ai/api/v1/calls")
.header("authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"phone_number\": \"<string>\",\n \"task\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.luly.ai/api/v1/calls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone_number\": \"<string>\",\n \"task\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "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.
Expected/Ideal Format
  • “+12223334444”
  • “+91223334444”
  • “+61223334444”
Valid, but not recommended:
  • “2223334444”
  • “+1 (222) 333-4444”
  • “+1 222 333 4444”
  • “222-333-4444”
Invalid
  • “12223334444”
  • “552223334444”
  • “non-numeric characters”
  • “2223334444 ext. 123”
task
string
required
Provide instructions, relevant information, and examples of the ideal conversation flow.

Out-of-the-Box Behaviors (Summarized):

  • Speech pattern: Direct, concise, casual
  • Spells out symbols, acronyms, abbreviations, percentages, etc. ($4,000,000 -> “four million dollars”)|
  • Asks clarifying questions
  • Ends call when objective is complete or voicemail is detected

Prompting Tips:

  • Want to easily test out exactly how your agent will behave?
  • Aim for less than >2,000 characters where possible.
  • Simple, direct prompts are the most predictable and reliable.
  • Frame instructions positively:
    • "Do this" rather than "Don't do this"
    • Ex. “Keep the conversation casual” rather than “Don’t be too formal”.
    • This gives concrete examples of what to do, instead of leaving expected behavior open to interpretation.

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"
}