Authorizations
API key authentication
Body
application/json
Array of campaign steps
Assets
Chat Deployment Logs
Chat Deployments
Voice Deployments
- GETList custom webhooks for a deployment
- POSTCreate a new custom webhook for voice deployment
- GETGet a specific custom webhook
- DELDelete a custom webhook
- PATCHUpdate a custom webhook
- GETGet all voice deployments for a worker
- POSTCreate a new voice deployment
- GETGet a single voice deployment
- DELDelete a voice deployment
- PATCHUpdate a voice deployment
- POSTMake batch calls for a voice deployment
Voice Deployment Logs
Flows
Integrations
Folders
Resources
Tests
Voice V1 Deployments
- GETGet all voice v1 deployments for a worker
- POSTCreate a new voice v1 deployment
- GETGet a single voice v1 deployment
- PUTUpdate a voice v1 deployment
- DELDelete a voice v1 deployment
- POSTCreate a new campaign for a voice v1 deployment
- POSTMake batch calls for a voice v1 deployment
- POSTRun a campaign with provided data
- GETGet a campaign by ID
- GETGet specific campaign data by ID
- PUTUpdate specific campaign data by ID
Create a new campaign for a voice v1 deployment
Copy
curl --request POST \
--url https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/deployments/voicev1/{deploymentId}/campaigns \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"steps": [
{}
]
}'Copy
{
"id": "<string>",
"status": "RUNNING",
"steps": [
{}
]
}Voice V1 Deployments
Create a new campaign for a voice v1 deployment
POST
/
api
/
workers
/
{workerId}
/
deployments
/
voicev1
/
{deploymentId}
/
campaigns
Create a new campaign for a voice v1 deployment
Copy
curl --request POST \
--url https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/deployments/voicev1/{deploymentId}/campaigns \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"steps": [
{}
]
}'Copy
{
"id": "<string>",
"status": "RUNNING",
"steps": [
{}
]
}⌘I