Assets
- POSTRegister a phone number for the team via Twilio integration.
- DELDelete a registered phone number for the team.
- GETGet all registered phone numbers for the team, optionally filtered by integration id.
- GETSearch for available phone numbers to purchase via Brainbase.
- POSTPurchase phone numbers via Brainbase Twilio account.
- POSTPurchase a phone number and register it as a WhatsApp sender.
- GETGet the status of a WhatsApp sender.
BusinessHours
Chat Deployment Logs
Chat Deployments
Chat Embed Deployment Logs
Chat Embed Deployments
Voice Deployments
- GETList custom webhooks for a deployment
- POSTCreate a new custom webhook for voice deployment
- GETGet a specific custom webhook
- DELDelete a custom webhook
- PATCHUpdate a custom webhook
- GETGet all voice deployments for a worker
- POSTCreate a new voice deployment
- GETGet a single voice deployment
- DELDelete a voice deployment
- PATCHUpdate a voice deployment
- POSTMake batch calls for a voice deployment
- POSTStop batch calls for a voice deployment
- POSTStop a specific campaign by removing its calls from the queue
Default Checks
- GETGet team default checks configuration
- PUTCreate or update team default checks configuration
- POSTInitialize team default checks with default values
- GETGet resolved default checks configuration for a deployment
- PUTCreate or update deployment-level default checks overrides
- DELRemove deployment-level overrides (revert to team defaults)
Deployment History
Voice Deployment Logs
Deployment Parameters
Deployments
Echo
- POSTSubmit an Echo test run (agent or suite) to Redis queue
- GETList Echo scorecards for the team
- POSTCreate an Echo scorecard
- GETGet a single Echo scorecard
- PUTUpdate an Echo scorecard
- DELDelete an Echo scorecard
- GETList test agents for the team
- POSTCreate a test agent
- PUTUpdate a test agent
- DELDelete a test agent
- GETList test suites for the team
- POSTCreate a test suite
- PUTUpdate a test suite
- DELDelete a test suite
Flows
Integrations
- POSTCreate a new Twilio integration for the authenticated team.
- DELDelete an existing Twilio integration.
- GETGet a specific integration by ID.
- PATCHUpdate an existing integration's name and description.
- GETGet all integrations for the authenticated team.
- GETGet Twilio subaccount credentials for the authenticated team.
LLM Logs
Log Exports
Outbound Campaigns
Folders
Resources
Runtime Errors
Tags
Team
TeamPhoneHours
Tests
Voice V1 Deployments
- GETGet all voice v1 deployments for a worker
- POSTCreate a new voice v1 deployment
- GETGet a single voice v1 deployment
- PUTUpdate a voice v1 deployment
- DELDelete a voice v1 deployment
- POSTCreate a new campaign for a voice v1 deployment
- POSTMake batch calls for a voice v1 deployment
- POSTRun a campaign with provided data
- GETGet a campaign by ID
- GETGet specific campaign data by ID
- PUTUpdate specific campaign data by ID
WhatsApp Deployment Logs
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
});
await client.voiceAnalysis.echo.agents.create({
goals: 'goals',
name: 'name',
purpose: 'purpose',
type: 'CHAT',
});Echo
Create a test agent
POST
/
api
/
echo
/
agents
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
});
await client.voiceAnalysis.echo.agents.create({
goals: 'goals',
name: 'name',
purpose: 'purpose',
type: 'CHAT',
});Documentation Index
Fetch the complete documentation index at: https://docs.usebrainbase.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
API key authentication
Body
application/json
Response
201
Created test agent
⌘I