GET
/
v1
/
batches
curl --request GET \
  --url https://app.luly.ai/api/v1/batches \
  --header 'authorization: <authorization>'
{
  "status": "success",
  "pathway_id": "9d404c1b-6a23-4426-953a-a52c392ff8f1"
}

Headers

authorization
string
required

Your API key for authentication.

Query Parameters

campaign_id
string

Retrieve only batches with a specific campaign ID.

from
integer

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

to
integer

The ending index for the range of batches to retrieve.

limit
integer

The maximum number of batches to return in the response.

ascending
boolean

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

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",
  "pathway_id": "9d404c1b-6a23-4426-953a-a52c392ff8f1"
}