Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
cURL
curl --request POST \ --url https://api.cartesia.ai/agents/calls/batches/{batch_id}/cancel \ --header 'Authorization: Bearer <token>' \ --header 'Cartesia-Version: <cartesia-version>'
import requests url = "https://api.cartesia.ai/agents/calls/batches/{batch_id}/cancel" headers = { "Cartesia-Version": "<cartesia-version>", "Authorization": "Bearer <token>" } response = requests.post(url, headers=headers) print(response.text)
const options = { method: 'POST', headers: {'Cartesia-Version': '<cartesia-version>', Authorization: 'Bearer <token>'} }; fetch('https://api.cartesia.ai/agents/calls/batches/{batch_id}/cancel', 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/{batch_id}/cancel", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_HTTPHEADER => [ "Authorization: Bearer <token>", "Cartesia-Version: <cartesia-version>" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.cartesia.ai/agents/calls/batches/{batch_id}/cancel" req, _ := http.NewRequest("POST", url, nil) req.Header.Add("Cartesia-Version", "<cartesia-version>") req.Header.Add("Authorization", "Bearer <token>") 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/{batch_id}/cancel") .header("Cartesia-Version", "<cartesia-version>") .header("Authorization", "Bearer <token>") .asString();
require 'uri' require 'net/http' url = URI("https://api.cartesia.ai/agents/calls/batches/{batch_id}/cancel") 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>' response = http.request(request) puts response.read_body
{ "id": "<string>", "name": "<string>", "agent_id": "<string>", "from_number_id": "<string>", "region": "US", "target_concurrency_limit": 123, "status": "pending", "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>", "end_reason": "agent_hangup", "error_message": "<string>" } ] }
Stops dialing the batch’s queued calls. Calls already in flight are left to finish. Idempotent.
Cartesia API key (sk_car_...). Get one at play.cartesia.ai/keys.
sk_car_...
API version header.
2026-08-14
"2026-08-14"
The ID of the batch.
The batch was cancelled.
The unique identifier for the batch.
The batch's label.
The identifier of the agent that handles the batch's calls.
The identifier of the phone number the batch dials from.
The region that handles the batch.
US
EU
APAC
Maximum number of calls from this batch dialed concurrently.
The batch's lifecycle status, derived at read time from dispatch progress.
pending
in_progress
completed
failed
cancelled
Total recipients queued in the batch.
Recipients handed to the dialer so far, including those that failed before a call could be placed.
Recipients whose latest call attempt reached a terminal state (completed or failed), including pre-dial failures.
Number of times the batch has been retried. 0 until the first retry.
0
When the batch was created.
When the batch was last updated.
The scheduled dispatch time, in RFC3339 UTC format. Omitted for batches that dispatch immediately.
The actual dispatch time, in RFC3339 UTC format. The batch may stay unadmitted in the queue due to scheduling or unavailable concurrency.
The batch's recipients. Returned only on GET /agents/calls/batches/{batch_id}.
GET /agents/calls/batches/{batch_id}
Show child attributes
このページは役に立ちましたか?