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
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": "eleven_turbo_v2",
"fallbackVoiceIds": [
"<string>"
],
"voiceTemperature": 123,
"voiceSpeed": 123,
"volume": 123,
"responsiveness": 123,
"interruptibility": 123,
"enableResponsiveReactions": true,
"responsiveReactionsFrequency": 123,
"responsiveReactionsWords": [
"<string>"
],
"reminderTriggerMs": 123,
"reminderMaxCount": 123,
"ambientSound": "<string>",
"ambientSoundVolume": 123,
"boostedKeywords": [
"<string>"
],
"enableTranscriptionFormatting": true,
"optOutSensitiveDataStorage": true,
"pronunciationDictionary": [
{
"word": "<string>",
"alphabet": "ipa",
"phoneme": "<string>"
}
],
"normalizeForSpeech": true,
"endCallAfterSilenceMs": 123,
"maxCallDurationMs": 123,
"enableVoicemailDetection": true,
"voicemailMessage": "<string>",
"voicemailDetectionTimeoutMs": 123,
"voiceEmotionEnabled": true,
"beginMessageDelayMs": 123,
"ringDurationMs": 123,
"audioEncoding": "<string>",
"sampleRate": 123,
"reduceSilence": true,
"fillerAudioEnabled": true
},
"enableVoiceSentiment": true,
"extractions": {},
"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": "eleven_turbo_v2",
"fallbackVoiceIds": [
"<string>"
],
"voiceTemperature": 123,
"voiceSpeed": 123,
"volume": 123,
"responsiveness": 123,
"interruptibility": 123,
"enableResponsiveReactions": true,
"responsiveReactionsFrequency": 123,
"responsiveReactionsWords": [
"<string>"
],
"reminderTriggerMs": 123,
"reminderMaxCount": 123,
"ambientSound": "<string>",
"ambientSoundVolume": 123,
"boostedKeywords": [
"<string>"
],
"enableTranscriptionFormatting": true,
"optOutSensitiveDataStorage": true,
"pronunciationDictionary": [
{
"word": "<string>",
"alphabet": "ipa",
"phoneme": "<string>"
}
],
"normalizeForSpeech": true,
"endCallAfterSilenceMs": 123,
"maxCallDurationMs": 123,
"enableVoicemailDetection": true,
"voicemailMessage": "<string>",
"voicemailDetectionTimeoutMs": 123,
"voiceEmotionEnabled": true,
"beginMessageDelayMs": 123,
"ringDurationMs": 123,
"audioEncoding": "<string>",
"sampleRate": 123,
"reduceSilence": true,
"fillerAudioEnabled": true
},
"enableVoiceSentiment": true,
"extractions": {},
"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.