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
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
Voice Deployments
Update a voice deployment
PATCH
/
api
/
workers
/
{workerId}
/
deployments
/
voice
/
{deploymentId}
Copy
curl --request PATCH \
--url https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/deployments/voice/{deploymentId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"name": "<string>",
"phoneNumber": "<string>",
"flowId": "<string>",
"externalConfig": {
"language": "<string>",
"voiceId": "<string>",
"voiceModel": "<string>",
"fallbackVoiceIds": "<string>",
"voiceTemperature": "<string>",
"voiceSpeed": "<string>",
"volume": "<string>",
"responsiveness": "<string>",
"interruptibility": "<string>",
"enableResponsiveReactions": "<string>",
"responsiveReactionsFrequency": "<string>",
"responsiveReactionsWords": "<string>",
"reminderTriggerMs": "<string>",
"reminderMaxCount": "<string>",
"ambientSound": "<string>",
"ambientSoundVolume": "<string>",
"boostedKeywords": "<string>",
"enableTranscriptionFormatting": "<string>",
"optOutSensitiveDataStorage": "<string>",
"pronunciationDictionary": "<string>",
"normalizeForSpeech": "<string>",
"endCallAfterSilenceMs": "<string>",
"maxCallDurationMs": "<string>",
"enableVoicemailDetection": "<string>",
"voicemailMessage": "<string>",
"voicemailDetectionTimeoutMs": "<string>",
"voiceEmotionEnabled": "<string>",
"beginMessageDelayMs": "<string>",
"ringDurationMs": "<string>",
"audioEncoding": "<string>",
"sampleRate": "<string>",
"reduceSilence": "<string>",
"fillerAudioEnabled": "<string>"
},
"enableVoiceSentiment": "<string>",
"extractions": "<string>",
"successCriteria": [
{
"title": "<string>",
"description": "<string>",
"items": [
{
"title": "<string>",
"description": "<string>",
"type": "BINARY",
"threshold": 123
}
]
}
]
}'
Copy
{
"id": "<string>",
"phoneNumber": "<string>",
"voiceProvider": "<string>",
"voiceId": "<string>",
"enableVoiceSentiment": true,
"agentId": "<string>",
"externalConfig": {}
}
Authorizations
API key authentication
Body
application/json
Response
200
application/json
Updated voice deployment
The response is of type object
.
Copy
curl --request PATCH \
--url https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/deployments/voice/{deploymentId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"name": "<string>",
"phoneNumber": "<string>",
"flowId": "<string>",
"externalConfig": {
"language": "<string>",
"voiceId": "<string>",
"voiceModel": "<string>",
"fallbackVoiceIds": "<string>",
"voiceTemperature": "<string>",
"voiceSpeed": "<string>",
"volume": "<string>",
"responsiveness": "<string>",
"interruptibility": "<string>",
"enableResponsiveReactions": "<string>",
"responsiveReactionsFrequency": "<string>",
"responsiveReactionsWords": "<string>",
"reminderTriggerMs": "<string>",
"reminderMaxCount": "<string>",
"ambientSound": "<string>",
"ambientSoundVolume": "<string>",
"boostedKeywords": "<string>",
"enableTranscriptionFormatting": "<string>",
"optOutSensitiveDataStorage": "<string>",
"pronunciationDictionary": "<string>",
"normalizeForSpeech": "<string>",
"endCallAfterSilenceMs": "<string>",
"maxCallDurationMs": "<string>",
"enableVoicemailDetection": "<string>",
"voicemailMessage": "<string>",
"voicemailDetectionTimeoutMs": "<string>",
"voiceEmotionEnabled": "<string>",
"beginMessageDelayMs": "<string>",
"ringDurationMs": "<string>",
"audioEncoding": "<string>",
"sampleRate": "<string>",
"reduceSilence": "<string>",
"fillerAudioEnabled": "<string>"
},
"enableVoiceSentiment": "<string>",
"extractions": "<string>",
"successCriteria": [
{
"title": "<string>",
"description": "<string>",
"items": [
{
"title": "<string>",
"description": "<string>",
"type": "BINARY",
"threshold": 123
}
]
}
]
}'
Copy
{
"id": "<string>",
"phoneNumber": "<string>",
"voiceProvider": "<string>",
"voiceId": "<string>",
"enableVoiceSentiment": true,
"agentId": "<string>",
"externalConfig": {}
}
Assistant
Responses are generated using AI and may contain mistakes.