POST
/
api
/
workers
/
{workerId}
/
deployments
/
voicev1
/
{deploymentId}
/
make-batch-calls
curl --request POST \
  --url https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/deployments/voicev1/{deploymentId}/make-batch-calls \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "data": [
    {
      "id": "<string>",
      "phoneNumber": "<string>",
      "status": "<string>"
    }
  ],
  "condition": "<string>",
  "extractions": {},
  "batch_size": "<string>",
  "batch_interval_minutes": "<string>",
  "wsUrl": "<string>",
  "additional_data": {}
}'

Authorizations

​
x-api-key
string
header
required

API key authentication

Path Parameters

​
workerId
string
required
​
deploymentId
string
required

Body

application/json
​
data
object[]
required

Array of data objects to process in batches, each requiring at least an id and phoneNumber

​
batch_size
string
required

Number of items to process in each batch (default 10)

​
batch_interval_minutes
string
required

Time interval between batches in minutes (default 5)

​
condition
string

Optional condition to evaluate for processing data. Supports template variables like {{variableName}}

​
extractions
object

Definitions of data to extract during calls, with each key representing a field to extract

​
wsUrl
string

Webhook URL to receive events when calls complete or extract data

​
additional_data
object

Additional data to pass with each request that will be available during the call

Response

200

Batch calls started successfully

Suggest editsRaise issue