Skip to main content
POST
Cancel Call Batch

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"

Path Parameters

batch_id
string
required

The ID of the batch.

Response

The batch was cancelled.

id
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.

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