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

​
x-api-key
string
header
required

API key authentication

Path Parameters

​
workerId
string
required

Body

application/json
​
name
string
required
​
phoneNumber
string
required
​
flowId
string
required
​
objective
string
required
​
startSentence
string
required
​
endSentence
string
required
​
voiceId
string
required
​
language
string
required
​
allowedTransferNumbers
string[]
required
​
functions
string
required
​
model
string
required
​
resourceKeys
string[]
required
​
wsBaseUrl
string
required
​
config
object
required

Response

201
application/json
Voice v1 deployment created
​
id
string
required
​
phoneNumber
string
required
​
objective
string
required
​
allowedTransferNumbers
string
required
​
resourceKeys
string
required
​
startSentence
string | null
​
endSentence
string | null
​
voiceId
string | null
​
language
string | null
​
functions
object | null
​
model
string | null
​
wsBaseUrl
string | null
Suggest editsRaise issue