Create Call Batch

curl --request POST \
  --url https://api.cartesia.ai/agents/calls/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Cartesia-Version: <cartesia-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "agent_id": "<string>",
  "from_number_id": "<string>",
  "recipients": [
    {
      "to_number": "<string>",
      "metadata": {}
    }
  ],
  "target_concurrency_limit": 2,
  "ringing_timeout_seconds": 42,
  "max_call_duration_minutes": 240,
  "scheduled_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.cartesia.ai/agents/calls/batches"

payload = {
    "name": "<string>",
    "agent_id": "<string>",
    "from_number_id": "<string>",
    "recipients": [
        {
            "to_number": "<string>",
            "metadata": {}
        }
    ],
    "target_concurrency_limit": 2,
    "ringing_timeout_seconds": 42,
    "max_call_duration_minutes": 240,
    "scheduled_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Cartesia-Version": "<cartesia-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Cartesia-Version': '<cartesia-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    agent_id: '<string>',
    from_number_id: '<string>',
    recipients: [{to_number: '<string>', metadata: {}}],
    target_concurrency_limit: 2,
    ringing_timeout_seconds: 42,
    max_call_duration_minutes: 240,
    scheduled_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.cartesia.ai/agents/calls/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://api.cartesia.ai/agents/calls/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([
    'name' => '<string>',
    'agent_id' => '<string>',
    'from_number_id' => '<string>',
    'recipients' => [
        [
                'to_number' => '<string>',
                'metadata' => [
                                
                ]
        ]
    ],
    'target_concurrency_limit' => 2,
    'ringing_timeout_seconds' => 42,
    'max_call_duration_minutes' => 240,
    'scheduled_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Cartesia-Version: <cartesia-version>",
    "Content-Type: application/json"
  ],
]);

$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://api.cartesia.ai/agents/calls/batches"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"from_number_id\": \"<string>\",\n  \"recipients\": [\n    {\n      \"to_number\": \"<string>\",\n      \"metadata\": {}\n    }\n  ],\n  \"target_concurrency_limit\": 2,\n  \"ringing_timeout_seconds\": 42,\n  \"max_call_duration_minutes\": 240,\n  \"scheduled_at\": \"2023-11-07T05:31:56Z\"\n}")

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

	req.Header.Add("Cartesia-Version", "<cartesia-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	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://api.cartesia.ai/agents/calls/batches")
  .header("Cartesia-Version", "<cartesia-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"from_number_id\": \"<string>\",\n  \"recipients\": [\n    {\n      \"to_number\": \"<string>\",\n      \"metadata\": {}\n    }\n  ],\n  \"target_concurrency_limit\": 2,\n  \"ringing_timeout_seconds\": 42,\n  \"max_call_duration_minutes\": 240,\n  \"scheduled_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cartesia.ai/agents/calls/batches")

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

request = Net::HTTP::Post.new(url)
request["Cartesia-Version"] = '<cartesia-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"from_number_id\": \"<string>\",\n  \"recipients\": [\n    {\n      \"to_number\": \"<string>\",\n      \"metadata\": {}\n    }\n  ],\n  \"target_concurrency_limit\": 2,\n  \"ringing_timeout_seconds\": 42,\n  \"max_call_duration_minutes\": 240,\n  \"scheduled_at\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "agent_id": "<string>",
  "from_number_id": "<string>",
  "target_concurrency_limit": 123,
  "total_calls_scheduled": 123,
  "total_calls_dispatched": 123,
  "total_calls_finished": 123,
  "retry_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "last_updated_at": "2023-11-07T05:31:56Z",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "admitted_at": "2023-11-07T05:31:56Z",
  "recipients": [
    {
      "id": "<string>",
      "to_number": "<string>",
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "agent_call_id": "<string>",
      "error_message": "<string>",
      "metadata": {}
    }
  ]
}

POST

agents

calls

batches

Create Call Batch

curl --request POST \
  --url https://api.cartesia.ai/agents/calls/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Cartesia-Version: <cartesia-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "agent_id": "<string>",
  "from_number_id": "<string>",
  "recipients": [
    {
      "to_number": "<string>",
      "metadata": {}
    }
  ],
  "target_concurrency_limit": 2,
  "ringing_timeout_seconds": 42,
  "max_call_duration_minutes": 240,
  "scheduled_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.cartesia.ai/agents/calls/batches"

payload = {
    "name": "<string>",
    "agent_id": "<string>",
    "from_number_id": "<string>",
    "recipients": [
        {
            "to_number": "<string>",
            "metadata": {}
        }
    ],
    "target_concurrency_limit": 2,
    "ringing_timeout_seconds": 42,
    "max_call_duration_minutes": 240,
    "scheduled_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Cartesia-Version": "<cartesia-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Cartesia-Version': '<cartesia-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    agent_id: '<string>',
    from_number_id: '<string>',
    recipients: [{to_number: '<string>', metadata: {}}],
    target_concurrency_limit: 2,
    ringing_timeout_seconds: 42,
    max_call_duration_minutes: 240,
    scheduled_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.cartesia.ai/agents/calls/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://api.cartesia.ai/agents/calls/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([
    'name' => '<string>',
    'agent_id' => '<string>',
    'from_number_id' => '<string>',
    'recipients' => [
        [
                'to_number' => '<string>',
                'metadata' => [
                                
                ]
        ]
    ],
    'target_concurrency_limit' => 2,
    'ringing_timeout_seconds' => 42,
    'max_call_duration_minutes' => 240,
    'scheduled_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Cartesia-Version: <cartesia-version>",
    "Content-Type: application/json"
  ],
]);

$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://api.cartesia.ai/agents/calls/batches"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"from_number_id\": \"<string>\",\n  \"recipients\": [\n    {\n      \"to_number\": \"<string>\",\n      \"metadata\": {}\n    }\n  ],\n  \"target_concurrency_limit\": 2,\n  \"ringing_timeout_seconds\": 42,\n  \"max_call_duration_minutes\": 240,\n  \"scheduled_at\": \"2023-11-07T05:31:56Z\"\n}")

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

	req.Header.Add("Cartesia-Version", "<cartesia-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	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://api.cartesia.ai/agents/calls/batches")
  .header("Cartesia-Version", "<cartesia-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"from_number_id\": \"<string>\",\n  \"recipients\": [\n    {\n      \"to_number\": \"<string>\",\n      \"metadata\": {}\n    }\n  ],\n  \"target_concurrency_limit\": 2,\n  \"ringing_timeout_seconds\": 42,\n  \"max_call_duration_minutes\": 240,\n  \"scheduled_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cartesia.ai/agents/calls/batches")

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

request = Net::HTTP::Post.new(url)
request["Cartesia-Version"] = '<cartesia-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"from_number_id\": \"<string>\",\n  \"recipients\": [\n    {\n      \"to_number\": \"<string>\",\n      \"metadata\": {}\n    }\n  ],\n  \"target_concurrency_limit\": 2,\n  \"ringing_timeout_seconds\": 42,\n  \"max_call_duration_minutes\": 240,\n  \"scheduled_at\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "agent_id": "<string>",
  "from_number_id": "<string>",
  "target_concurrency_limit": 123,
  "total_calls_scheduled": 123,
  "total_calls_dispatched": 123,
  "total_calls_finished": 123,
  "retry_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "last_updated_at": "2023-11-07T05:31:56Z",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "admitted_at": "2023-11-07T05:31:56Z",
  "recipients": [
    {
      "id": "<string>",
      "to_number": "<string>",
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "agent_call_id": "<string>",
      "error_message": "<string>",
      "metadata": {}
    }
  ]
}

Authorizations

Authorization

string

header

default:$CARTESIA_API_KEY

required

Cartesia API key (sk_car_...). Get one at play.cartesia.ai/keys.

Headers

Cartesia-Version

enum<string>

default:2026-03-01

required

API version header.

Available options:

2026-03-01

Example:

"2026-03-01"

Body

application/json

Request body for queueing a batch of outbound calls.

name

string

required

A label for the batch.

agent_id

string

required

The identifier of the agent that handles the batch's calls.

from_number_id

string

required

The identifier of the phone number to place calls from. The attached provider handles outbound calling for this number.

recipients

AgentOutboundCallItem · object[]

required

Per-call destination and metadata configuration. Up to 5,000 recipients per batch.

Required array length: 1 - 5000 elements

Show child attributes

target_concurrency_limit

integer

Maximum number of calls from this batch to dial concurrently. Must not exceed the organization's concurrency limit. Omit to default to half of the organization's agent-call concurrency limit, leaving headroom for other calls.

Required range: x >= 1

ringing_timeout_seconds

integer

Seconds to wait for the callee to answer before giving up. Omit to use the default (60 seconds).

Required range: 5 <= x <= 80

max_call_duration_minutes

integer

Maximum call duration in minutes. Omit to use the default (480 minutes).

Required range: 1 <= x <= 480

scheduled_at

string<date-time>

When to start dispatching the batch, as an RFC3339 timestamp with a timezone offset (e.g. 2026-06-15T16:00:00Z). Must be in the future and within 30 days. Omit to dispatch immediately.

region

enum<string>

The region from which the batch's outbound calls are dispatched. Valid only when from_number_id is a SIP-trunk number; rejected for other telephony account types. Omit to derive the region from the telephony account.

Available options:

US,

EU,

APAC

Response

The created batch, with all of its call requests queued.

string

required

The unique identifier for the batch.

name

string

required

The batch's label.

agent_id

string

required

The identifier of the agent that handles the batch's calls.

from_number_id

string

required

The identifier of the phone number the batch dials from.

region

enum<string>

required

The deployment region whose dispatcher drains the batch.

Available options:

US,

EU,

APAC

target_concurrency_limit

integer

required

Maximum number of calls from this batch dialed concurrently.

status

enum<string>

required

The batch's lifecycle status, derived at read time from dispatch progress.

Status	Meaning
`pending`	No calls dispatched yet
`in_progress`	Some calls dispatched, not all
`completed`	All recipients dispatched
`failed`	All recipients failed before dialing
`cancelled`	Cancelled before every call was dispatched

Available options:

pending,

in_progress,

completed,

failed,

cancelled

total_calls_scheduled

integer

required

Total recipients queued in the batch.

total_calls_dispatched

integer

required

Recipients handed to the dialer so far, including those that failed before a call could be placed.

total_calls_finished

integer

required

Recipients whose latest call attempt reached a terminal state (completed or failed), including pre-dial failures.

retry_count

integer

required

Number of times the batch has been retried. 0 until the first retry.

created_at

string<date-time>

required

When the batch was created.

last_updated_at

string<date-time>

required

When the batch was last updated.

scheduled_at

string<date-time>

The scheduled dispatch time, in RFC3339 UTC format. Omitted for batches that dispatch immediately.

admitted_at

string<date-time>

The actual dispatch time, in RFC3339 UTC format. The batch may stay unadmitted in the queue due to scheduling or unavailable concurrency.

recipients

AgentCallBatchRecipient · object[]

The batch's recipients. Returned only on GET /agents/calls/batches/{batch_id}.

Show child attributes

Download Call Audio

List Call Batches

⌘I

Use the API

API Status

TTS

STT

Agents

Auth

Voices

Pronunciation Dicts

Datasets

Fine Tunes

Infill

Admin

Create Call Batch

Authorizations

Headers

Body

Response