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);import os
from brainbase_labs import BrainbaseLabs
client = BrainbaseLabs(
api_key=os.environ.get("BRAINBASE_LABS_API_KEY"), # This is the default and can be omitted
)
response = client.voice_analysis.retrieve_deployment(
deployment_id="deploymentId",
)
print(response.id)curl --request GET \
--url https://brainbase-monorepo-api.onrender.com/api/deployments/{deploymentId} \
--header 'x-api-key: <api-key>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://brainbase-monorepo-api.onrender.com/api/deployments/{deploymentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://brainbase-monorepo-api.onrender.com/api/deployments/{deploymentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://brainbase-monorepo-api.onrender.com/api/deployments/{deploymentId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://brainbase-monorepo-api.onrender.com/api/deployments/{deploymentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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": {}
}{
"error": "API key is required",
"code": "UNAUTHORIZED"
}{
"error": "Deployment not found"
}Deployments
Retrieve a deployment by ID
Fetches a single deployment record by its ID, without requiring the worker ID. Works for all deployment types: Voice, VoiceV1, Chat, ChatEmbed, Whatsapp, SMS, Email, Slack, and API. Delegate-specific fields are flattened into the response automatically.
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);import os
from brainbase_labs import BrainbaseLabs
client = BrainbaseLabs(
api_key=os.environ.get("BRAINBASE_LABS_API_KEY"), # This is the default and can be omitted
)
response = client.voice_analysis.retrieve_deployment(
deployment_id="deploymentId",
)
print(response.id)curl --request GET \
--url https://brainbase-monorepo-api.onrender.com/api/deployments/{deploymentId} \
--header 'x-api-key: <api-key>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://brainbase-monorepo-api.onrender.com/api/deployments/{deploymentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://brainbase-monorepo-api.onrender.com/api/deployments/{deploymentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://brainbase-monorepo-api.onrender.com/api/deployments/{deploymentId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://brainbase-monorepo-api.onrender.com/api/deployments/{deploymentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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": {}
}{
"error": "API key is required",
"code": "UNAUTHORIZED"
}{
"error": "Deployment not found"
}Authorizations
API key authentication
Path Parameters
The deployment ID (e.g. deploy_531965ce-ff0f-45bd-8495-33cd86329610)
Query Parameters
Comma-separated list of relations to include. Supported: sentinelAssignments, successCriteria, deploymentParameters.
Response
Deployment record with type-specific fields flattened
The deployment delegate type
Available options:
VoiceDeployment, VoiceV1Deployment, ChatDeployment, EmailDeployment, SlackDeployment 