GET
/
v1
/
batches
curl --request GET \
  --url https://api.bland.ai/v1/batches \
  --header 'authorization: <authorization>'
{
    "status": "success",
    "batches": [
        {
            "batch_id": "ZfowpkhOSVCZJ94i-gen-batch",
            "campaign_id": "a2shduf92f74p8288c93nid5",
            "created_at": "2023-11-16T22:14:24.9663+00:00",
            "label": "Subscription Renewal Reminders",
            "base_prompt": "You are calling {{business}} and need to let them know that their subscription to {{service}} is going to expire on {{date}}. If they'd like to renew, take their credit card information and bill them through {{url}}",
            "endpoint_code": "api",
            "call_params": {
                "reduce_latency": true,
                "voice_id": 2,
                "language": "eng",
                "request_data": {
                    "test_param": "request data.test_param",
                    "your name": "Janessa"
                },
                "max_duration": 5,
                "wait_for_greeting": false
            }
        },
        //...
    ]
}

Headers

authorization
string
required

Your API key for authentication.

Query Parameters

campaign_id
string

Retrieve only batches with a specific campaign ID.

from
int

The starting index (inclusive) for the range of batches to retrieve.

to
int

The ending index for the range of batches to retrieve.

limit
int
default: "1000"

The maximum number of batches to return in the response.

ascending
boolean
default: "false"

Whether to sort the batches in ascending order of their creation time.

Response

status
string

Can be success or error.

batches
array

Contains an array of batch objects.

batches[i].batch_id
string

The unique identifier for the batch.

batches[i].base_prompt
string

The original base prompt used to create the batch. Will still contain the original placeholder variables such as {{ business }} or {{ name }}.

batches[i].label
string

The label you assigned to the batch (if any).

batches[i].endpoint_code
string
default: "API"

Enterprise customers with custom endpoints will see the endpoint code here (if specified).

batches[i].call_params
array

The base call parameters used to create the batch, such as voice_id, max_duration, reduce_latency, and wait_for_greeting.

batches[i].created_at
string

The date and time the batch was created.

{
    "status": "success",
    "batches": [
        {
            "batch_id": "ZfowpkhOSVCZJ94i-gen-batch",
            "campaign_id": "a2shduf92f74p8288c93nid5",
            "created_at": "2023-11-16T22:14:24.9663+00:00",
            "label": "Subscription Renewal Reminders",
            "base_prompt": "You are calling {{business}} and need to let them know that their subscription to {{service}} is going to expire on {{date}}. If they'd like to renew, take their credit card information and bill them through {{url}}",
            "endpoint_code": "api",
            "call_params": {
                "reduce_latency": true,
                "voice_id": 2,
                "language": "eng",
                "request_data": {
                    "test_param": "request data.test_param",
                    "your name": "Janessa"
                },
                "max_duration": 5,
                "wait_for_greeting": false
            }
        },
        //...
    ]
}