|  | 
| 1 |  | -# Brainbase Component for Pipedream | 
|  | 1 | +# Brainbase | 
| 2 | 2 | 
 | 
| 3 |  | -This component integrates Brainbase API with Pipedream, allowing you to automate workflows with Brainbase's voice AI and worker management capabilities. | 
|  | 3 | +Brainbase is a platform for building and deploying AI voice agents. Create intelligent workers that can handle phone calls, automate customer interactions, and integrate with your existing communication infrastructure. | 
| 4 | 4 | 
 | 
| 5 |  | -## Authentication | 
| 6 |  | - | 
| 7 |  | -This component uses API Key authentication. You'll need to provide your Brainbase API key when connecting the app in Pipedream. | 
| 8 |  | - | 
| 9 |  | -- **Authentication Type**: API Key | 
| 10 |  | -- **Header**: `x-api-key` | 
| 11 |  | -- **Base URL**: `https://brainbase-monorepo-api.onrender.com` | 
| 12 |  | - | 
| 13 |  | -## Available Actions | 
| 14 |  | - | 
| 15 |  | -### Workers | 
| 16 |  | - | 
| 17 |  | -- **Create Worker** - Create a new worker for the team | 
| 18 |  | -- **Get Worker** - Get a single worker by ID | 
| 19 |  | -- **List Workers** - Get all workers for the team | 
| 20 |  | -- **Update Worker** - Update an existing worker | 
| 21 |  | -- **Delete Worker** - Delete a worker | 
| 22 |  | - | 
| 23 |  | -### Flows | 
| 24 |  | - | 
| 25 |  | -- **Create Flow** - Create a new flow for a worker | 
| 26 |  | -- **Get Flow** - Get a single flow by ID | 
| 27 |  | -- **List Flows** - Get all flows for a worker | 
| 28 |  | -- **Update Flow** - Update an existing flow | 
| 29 |  | -- **Delete Flow** - Delete a flow | 
| 30 |  | - | 
| 31 |  | -### Voice Deployments | 
|  | 5 | +## What You Can Do | 
| 32 | 6 | 
 | 
| 33 |  | -- **Create Voice Deployment** - Create a new voice deployment | 
| 34 |  | -- **Get Voice Deployment** - Get a single voice deployment by ID | 
| 35 |  | -- **List Voice Deployments** - Get all voice deployments for a worker | 
| 36 |  | -- **Update Voice Deployment** - Update an existing voice deployment | 
| 37 |  | -- **Delete Voice Deployment** - Delete a voice deployment | 
| 38 |  | -- **Make Voice Batch Calls** - Make batch calls for a voice deployment | 
|  | 7 | +With the Brainbase integration on Pipedream, you can: | 
| 39 | 8 | 
 | 
| 40 |  | -### Voice Deployment Logs | 
|  | 9 | +- **Automate Voice Agent Deployments** - Programmatically create and configure AI voice agents that can make or receive phone calls | 
|  | 10 | +- **Monitor Call Activity** - Track voice deployment logs, analyze sentiment, and retrieve call records for quality assurance | 
|  | 11 | +- **Manage Phone Numbers** - Register and configure phone numbers for your voice agents through Twilio integration | 
|  | 12 | +- **Build Dynamic Workflows** - Create AI workers with custom flows that adapt based on triggers from other apps in your Pipedream workflows | 
|  | 13 | +- **Scale Communications** - Make batch calls to multiple recipients with personalized AI interactions | 
| 41 | 14 | 
 | 
| 42 |  | -- **List Voice Deployment Logs** - List voice deployment logs with filtering and pagination | 
| 43 |  | -- **Get Voice Deployment Log** - Retrieve a single voice deployment log record | 
|  | 15 | +## Use Cases | 
| 44 | 16 | 
 | 
| 45 |  | -### Integrations (Twilio) | 
|  | 17 | +### Customer Support Automation | 
| 46 | 18 | 
 | 
| 47 |  | -- **Create Twilio Integration** - Create a new Twilio integration | 
| 48 |  | -- **Get Integration** - Get a specific integration by ID | 
| 49 |  | -- **List Integrations** - Get all integrations for the team | 
| 50 |  | -- **Delete Integration** - Delete an existing integration | 
|  | 19 | +Automatically deploy voice agents when support tickets are created in Zendesk or when specific keywords are detected in emails. Route calls based on customer data and log interactions back to your CRM. | 
| 51 | 20 | 
 | 
| 52 |  | -### Phone Numbers (Assets) | 
|  | 21 | +### Appointment Reminders | 
| 53 | 22 | 
 | 
| 54 |  | -- **Register Phone Number** - Register a phone number via Twilio integration | 
| 55 |  | -- **Get Phone Numbers** - Get all registered phone numbers (with optional filtering) | 
| 56 |  | -- **Delete Phone Number** - Delete a registered phone number | 
|  | 23 | +Trigger AI voice calls to remind customers of upcoming appointments when calendar events approach. Collect confirmations and automatically update your scheduling system. | 
| 57 | 24 | 
 | 
| 58 |  | -### Team | 
|  | 25 | +### Lead Qualification | 
| 59 | 26 | 
 | 
| 60 |  | -- **Get Team** - Get the team associated with the API key | 
|  | 27 | +Deploy voice agents to call leads from your sales pipeline, ask qualification questions, and route hot leads to human sales reps based on responses and sentiment analysis. | 
| 61 | 28 | 
 | 
| 62 |  | -## Usage Example | 
|  | 29 | +### Outbound Notifications | 
| 63 | 30 | 
 | 
| 64 |  | -### Creating a Worker and Flow | 
|  | 31 | +Send voice notifications for order updates, delivery alerts, or account changes by triggering calls when status changes occur in your e-commerce or SaaS platform. | 
| 65 | 32 | 
 | 
| 66 |  | -1. **Create Worker** | 
|  | 33 | +## Getting Started | 
| 67 | 34 | 
 | 
| 68 |  | -   ```javascript | 
| 69 |  | -   // Use the "Create Worker" action | 
| 70 |  | -   { | 
| 71 |  | -     "name": "Customer Support Bot", | 
| 72 |  | -     "description": "Handles customer inquiries", | 
| 73 |  | -     "status": "active" | 
| 74 |  | -   } | 
| 75 |  | -   ``` | 
|  | 35 | +1. Connect your Brainbase account using your API key | 
|  | 36 | +2. Create a worker to define your AI agent's purpose | 
|  | 37 | +3. Build a flow to script your agent's conversation logic | 
|  | 38 | +4. Deploy your voice agent with a phone number | 
|  | 39 | +5. Integrate with other Pipedream apps to trigger or respond to voice interactions | 
| 76 | 40 | 
 | 
| 77 |  | -2. **Create Flow** | 
| 78 |  | - | 
| 79 |  | -   ```javascript | 
| 80 |  | -   // Use the "Create Flow" action | 
| 81 |  | -   { | 
| 82 |  | -     "workerId": "worker_123", | 
| 83 |  | -     "name": "Support Flow", | 
| 84 |  | -     "code": "// Your flow code here", | 
| 85 |  | -     "validate": true | 
| 86 |  | -   } | 
| 87 |  | -   ``` | 
| 88 |  | - | 
| 89 |  | -3. **Create Voice Deployment** | 
| 90 |  | -   ```javascript | 
| 91 |  | -   // Use the "Create Voice Deployment" action | 
| 92 |  | -   { | 
| 93 |  | -     "workerId": "worker_123", | 
| 94 |  | -     "name": "Support Hotline", | 
| 95 |  | -     "phoneNumber": "+1234567890", | 
| 96 |  | -     "flowId": "flow_456", | 
| 97 |  | -     "enableVoiceSentiment": true, | 
| 98 |  | -     "externalConfig": { | 
| 99 |  | -       "voice": "alloy", | 
| 100 |  | -       "language": "en" | 
| 101 |  | -     } | 
| 102 |  | -   } | 
| 103 |  | -   ``` | 
| 104 |  | - | 
| 105 |  | -## Testing | 
| 106 |  | - | 
| 107 |  | -To test the component locally: | 
| 108 |  | - | 
| 109 |  | -1. Ensure you have your Brainbase API key | 
| 110 |  | -2. Use the Pipedream CLI or web interface to test actions | 
| 111 |  | -3. Start with simple actions like "Get Team" or "List Workers" to verify connectivity | 
| 112 |  | - | 
| 113 |  | -## API Documentation | 
| 114 |  | - | 
| 115 |  | -For more information about the Brainbase API, visit [Brainbase Documentation](https://docs.brainbase.com). | 
| 116 |  | - | 
| 117 |  | -## Version | 
|  | 41 | +## Authentication | 
| 118 | 42 | 
 | 
| 119 |  | -Current version: 0.0.1 | 
|  | 43 | +This integration uses API Key authentication. You'll need to provide your Brainbase API key when connecting the app in Pipedream. | 
| 120 | 44 | 
 | 
| 121 |  | -## Support | 
|  | 45 | +## Links | 
| 122 | 46 | 
 | 
| 123 |  | -For issues or questions, please contact Pipedream support or visit the [Pipedream community](https://pipedream.com/community). | 
|  | 47 | +- [Brainbase Documentation](https://docs.usebrainbase.com) | 
|  | 48 | +- [Pipedream Community](https://pipedream.com/community) | 
0 commit comments