Assets
Chat Deployment Logs
Chat 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
Voice Deployment Logs
Flows
Integrations
Folders
Resources
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
Tests
Create a new test
POST
/
api
/
workers
/
{workerId}
/
tests
Copy
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 test = await client.workers.tests.create('workerId', {
checkpoints: [{ description: 'description', name: 'name', runs: 0, tolerance: 0 }],
description: 'description',
flowId: 'flowId',
name: 'name',
systemPrompt: 'systemPrompt',
testMode: 'testMode',
});
console.log(test.id);
}
main();
Copy
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"testMode": "<string>",
"websocketUrl": "<string>",
"systemPrompt": "<string>",
"checkpoints": {},
"workerId": "<string>",
"flowId": "<string>"
}
Authorizations
API key authentication
Path Parameters
Body
application/json
Response
201
application/json
Test created
The response is of type object
.
Copy
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 test = await client.workers.tests.create('workerId', {
checkpoints: [{ description: 'description', name: 'name', runs: 0, tolerance: 0 }],
description: 'description',
flowId: 'flowId',
name: 'name',
systemPrompt: 'systemPrompt',
testMode: 'testMode',
});
console.log(test.id);
}
main();
Copy
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"testMode": "<string>",
"websocketUrl": "<string>",
"systemPrompt": "<string>",
"checkpoints": {},
"workerId": "<string>",
"flowId": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.