Send a Batch of Calls

curl --request POST \
  --url https://app.luly.ai/api/v1/batches \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '
{
  "base_prompt": "<string>",
  "call_data": [
    {}
  ],
  "from": "<string>",
  "label": "<string>",
  "campaign_id": "<string>",
  "test_mode": true
}
'

import requests

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

payload = {
    "base_prompt": "<string>",
    "call_data": [{}],
    "from": "<string>",
    "label": "<string>",
    "campaign_id": "<string>",
    "test_mode": True
}
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({
    base_prompt: '<string>',
    call_data: [{}],
    from: '<string>',
    label: '<string>',
    campaign_id: '<string>',
    test_mode: true
  })
};

fetch('https://app.luly.ai/api/v1/batches', 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/batches",
  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([
    'base_prompt' => '<string>',
    'call_data' => [
        [
                
        ]
    ],
    'from' => '<string>',
    'label' => '<string>',
    'campaign_id' => '<string>',
    'test_mode' => true
  ]),
  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/batches"

	payload := strings.NewReader("{\n  \"base_prompt\": \"<string>\",\n  \"call_data\": [\n    {}\n  ],\n  \"from\": \"<string>\",\n  \"label\": \"<string>\",\n  \"campaign_id\": \"<string>\",\n  \"test_mode\": true\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/batches")
  .header("authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"base_prompt\": \"<string>\",\n  \"call_data\": [\n    {}\n  ],\n  \"from\": \"<string>\",\n  \"label\": \"<string>\",\n  \"campaign_id\": \"<string>\",\n  \"test_mode\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"base_prompt\": \"<string>\",\n  \"call_data\": [\n    {}\n  ],\n  \"from\": \"<string>\",\n  \"label\": \"<string>\",\n  \"campaign_id\": \"<string>\",\n  \"test_mode\": true\n}"

response = http.request(request)
puts response.read_body

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

POST

batches

Send a Batch of Calls

curl --request POST \
  --url https://app.luly.ai/api/v1/batches \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '
{
  "base_prompt": "<string>",
  "call_data": [
    {}
  ],
  "from": "<string>",
  "label": "<string>",
  "campaign_id": "<string>",
  "test_mode": true
}
'

import requests

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

payload = {
    "base_prompt": "<string>",
    "call_data": [{}],
    "from": "<string>",
    "label": "<string>",
    "campaign_id": "<string>",
    "test_mode": True
}
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({
    base_prompt: '<string>',
    call_data: [{}],
    from: '<string>',
    label: '<string>',
    campaign_id: '<string>',
    test_mode: true
  })
};

fetch('https://app.luly.ai/api/v1/batches', 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/batches",
  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([
    'base_prompt' => '<string>',
    'call_data' => [
        [
                
        ]
    ],
    'from' => '<string>',
    'label' => '<string>',
    'campaign_id' => '<string>',
    'test_mode' => true
  ]),
  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/batches"

	payload := strings.NewReader("{\n  \"base_prompt\": \"<string>\",\n  \"call_data\": [\n    {}\n  ],\n  \"from\": \"<string>\",\n  \"label\": \"<string>\",\n  \"campaign_id\": \"<string>\",\n  \"test_mode\": true\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/batches")
  .header("authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"base_prompt\": \"<string>\",\n  \"call_data\": [\n    {}\n  ],\n  \"from\": \"<string>\",\n  \"label\": \"<string>\",\n  \"campaign_id\": \"<string>\",\n  \"test_mode\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"base_prompt\": \"<string>\",\n  \"call_data\": [\n    {}\n  ],\n  \"from\": \"<string>\",\n  \"label\": \"<string>\",\n  \"campaign_id\": \"<string>\",\n  \"test_mode\": true\n}"

response = http.request(request)
puts response.read_body

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

Headers

string

required

Your API key for authentication.

Body

string

required

This is the prompt or task used for all the phone calls in the request. Information can be inserted into it surrounding variable names with curly braces.Example:

"You are calling business to renew their subscription to service before it expires on date."
;

array

required

Define a list of calls to make and their properties. Each call in call_data MUST have a “phone_number” property. Properties are case-sensitive.Example:

{   
  "phone_number": "1234567890",
  "business": "ABC Corp",
  "service": "Netflix",
  "date": "September 4th"
},
{
  "phone_number": "32176540987",
  "business": "XYZ inc.",
  "service": "Window Cleaning",
  "date": "December 20th"
}
]";

string

Use a purchased number to send batch calls from. We do not recommend this for large batches as there is risk of your number getting flagged for spam.

string

Adds a user-friendly label to your batch to keep track of it’s original intention. This can help differentiate multiple call batches that are part of the same Campaign. Shown when a batch is retreived

string

Use campaign_id to organize related batches together. This can be set manually or auto-generated through Campaigns.

boolean

When this is set to true, only the first call of call_data will be dispatched. A common use case is to set the first phone_number value to your own to confirm everything’s set up properly.Includes additional information in the response when true so that it’s easier to find any issues.

All other parameters supported by the Send Call endpoint are supported here as well. They will be applied to each call in the batch. A URL that will receive a POST request when the batch is completed. The request will include the batch_id and the status of the batch.

Response

string

If anything other than “success” is returned, there was an error.

string

The unique identifier for the batch.

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

Basic

Calls

Vector Stores

Conversational Pathways

Inbound Numbers

Outbound Numbers

Voices

Custom Tools

Web Agents

Custom Twilio Accounts

Campaigns

Prompts

Batches

SMS

Send a Batch of Calls

Headers

Body

Response

​Headers

​Body

​Response

Headers

Body

Response