Voice V1 Deployments
Create a new voice v1 deployment
Assets
Voice Deployment Logs
Voice Deployments
Flows
Integrations
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
Voice V1 Deployments
Create a new voice v1 deployment
POST
/
api
/
workers
/
{workerId}
/
deployments
/
voicev1
curl --request POST \
--url https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/deployments/voicev1 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"name": "<string>",
"phoneNumber": "<string>",
"flowId": "<string>",
"objective": "<string>",
"startSentence": "<string>",
"endSentence": "<string>",
"voiceId": "<string>",
"language": "<string>",
"allowedTransferNumbers": [
"<string>"
],
"functions": "<string>",
"model": "<string>",
"resourceKeys": [
"<string>"
],
"wsBaseUrl": "<string>",
"config": {}
}'
{
"id": "<string>",
"phoneNumber": "<string>",
"objective": "<string>",
"startSentence": "<string>",
"endSentence": "<string>",
"voiceId": "<string>",
"language": "<string>",
"allowedTransferNumbers": "<string>",
"functions": {},
"model": "<string>",
"resourceKeys": "<string>",
"wsBaseUrl": "<string>"
}
Authorizations
API key authentication
Path Parameters
Body
application/json
Response
201
application/json
Voice v1 deployment created
The response is of type object
.
curl --request POST \
--url https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/deployments/voicev1 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"name": "<string>",
"phoneNumber": "<string>",
"flowId": "<string>",
"objective": "<string>",
"startSentence": "<string>",
"endSentence": "<string>",
"voiceId": "<string>",
"language": "<string>",
"allowedTransferNumbers": [
"<string>"
],
"functions": "<string>",
"model": "<string>",
"resourceKeys": [
"<string>"
],
"wsBaseUrl": "<string>",
"config": {}
}'
{
"id": "<string>",
"phoneNumber": "<string>",
"objective": "<string>",
"startSentence": "<string>",
"endSentence": "<string>",
"voiceId": "<string>",
"language": "<string>",
"allowedTransferNumbers": "<string>",
"functions": {},
"model": "<string>",
"resourceKeys": "<string>",
"wsBaseUrl": "<string>"
}