POST
/
batch
/
stop
curl --request POST \
  --url https://api.bland.ai/batch/stop \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "batch_id": "<string>"
}'
{
  "status": "success",
  "message": "Successfully stopped batch",
  "num_calls": 1204,
  "batch_id": "5e5b1a3a-2b0a-4b9e-8b9e-asdf-gen-batch"
}

Headers

authorization
string
required

Your API key for authentication.

Body

batch_id
string
required

The unique identifier for the batch to be cancelled.

Response

status
string

The status of the request. If anything other than ‘success’, an error has occurred or all calls have already been completed.

message
string

A message describing the status of the request.

num_calls
number

The number of calls that were cancelled.

batch_id
array

The batch_id of the cancelled batch.