GET
/
api
/
workers
/
{workerId}
/
deployments
/
voicev1
/
{deploymentId}
import BrainbaseLabs from 'brainbase-labs';

const client = new BrainbaseLabs({
  apiKey: process.env['BRAINBASE_LABS_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const voiceV1Deployment = await client.workers.deployments.voicev1.retrieve('deploymentId', {
    workerId: 'workerId',
  });

  console.log(voiceV1Deployment.id);
}

main();
{
  "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
deploymentId
string
required

Response

200
application/json
Voice v1 deployment details
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