POST
/
api
/
workers
/
{workerId}
/
deployments
/
voice
curl --request POST \
  --url https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/deployments/voice \
  --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
        }
      ]
    }
  ]
}'
{
  "id": "<string>",
  "phoneNumber": "<string>",
  "voiceProvider": "<string>",
  "voiceId": "<string>",
  "enableVoiceSentiment": true,
  "agentId": "<string>",
  "externalConfig": {}
}

Authorizations

x-api-key
string
header
required

API key authentication

Path Parameters

workerId
string
required

Body

application/json

Response

201
application/json

Voice deployment created

The response is of type object.