Skip to main content
GET
/
api
/
deployments
/
{deploymentId}
JavaScript
import BrainbaseLabs from 'brainbase-labs';

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

const response = await client.voiceAnalysis.retrieveDeployment('deploymentId');

console.log(response.id);
{
  "id": "<string>",
  "name": "<string>",
  "type": "VoiceDeployment",
  "status": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "workerId": "<string>",
  "flowId": "<string>",
  "config": {},
  "flowVersionId": "<string>",
  "extractions": {},
  "engineModel": "<string>",
  "visualizations": {}
}

Authorizations

x-api-key
string
header
required

API key authentication

Path Parameters

deploymentId
string
required

The deployment ID (e.g. deploy_531965ce-ff0f-45bd-8495-33cd86329610)

Query Parameters

include
string

Comma-separated list of relations to include. Supported: sentinelAssignments, successCriteria, deploymentParameters.

Response

Deployment record with type-specific fields flattened

id
string
required
name
string
required
type
enum<string>
required

The deployment delegate type

Available options:
VoiceDeployment,
VoiceV1Deployment,
ChatDeployment,
EmailDeployment,
SlackDeployment
status
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
workerId
string
required
flowId
string
required
config
object
required
flowVersionId
string | null
extractions
object
engineModel
string | null
visualizations
object