Create Voice Deployment with Brainbase Labs API

Pipedream makes it easy to connect APIs for Brainbase Labs and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Voice Deployment with the Brainbase Labs API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Create Voice Deployment with the Brainbase Labs API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Voice Deployment action
1. Connect your Brainbase Labs account
2. Select a Worker ID
3. Configure Name
4. Configure Phone Number
5. Select a Flow ID
6. Configure Enable Voice Sentiment
7. Optional- Configure External Config
8. Configure Extractions Key
9. Select a Extractions Type
10. Configure Extractions Description
11. Configure Extractions Required
12. Optional- Configure Success Criteria
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create Voice Deployment on Brainbase Labs

Description:Create a new voice deployment. [See the documentation](https://docs.usebrainbase.com/api-reference/voice-deployments/create-a-new-voice-deployment)

Version:0.0.1

Key:brainbase_labs-create-voice-deployment

View on GitHub

Code#

import app from "../../brainbase_labs.app.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "brainbase_labs-create-voice-deployment",
  name: "Create Voice Deployment",
  description: "Create a new voice deployment. [See the documentation](https://docs.usebrainbase.com/api-reference/voice-deployments/create-a-new-voice-deployment)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    app,
    workerId: {
      propDefinition: [
        app,
        "workerId",
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "Deployment name",
    },
    phoneNumber: {
      type: "string",
      label: "Phone Number",
      description: "Phone number for deployment (e.g., +1234567890)",
    },
    flowId: {
      propDefinition: [
        app,
        "flowId",
        (c) => ({
          workerId: c.workerId,
        }),
      ],
    },
    enableVoiceSentiment: {
      type: "boolean",
      label: "Enable Voice Sentiment",
      description: "Enable voice sentiment analysis",
      default: false,
    },
    externalConfig: {
      type: "object",
      label: "External Config",
      description:
        "External configuration object with voice settings, language, voiceId, etc. Example: `{\"voice\": \"alloy\", \"language\": \"en\"}`",
      optional: true,
    },
    extractionsKey: {
      type: "string",
      label: "Extractions Key",
      description: "The key of the extractions to use for the deployment",
    },
    extractionsType: {
      type: "string",
      label: "Extractions Type",
      description: "The type of the extractions to use for the deployment",
      options: [
        "string",
        "number",
        "boolean",
      ],
    },
    extractionsDescription: {
      type: "string",
      label: "Extractions Description",
      description: "The description of the extractions to use for the deployment",
    },
    extractionsRequired: {
      type: "boolean",
      label: "Extractions Required",
      description: "Whether the extractions are required for the deployment",
    },
    successCriteria: {
      type: "string[]",
      label: "Success Criteria",
      description: "Deployment success measurement criteria (optional)",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.app.createVoiceDeployment({
      $,
      workerId: this.workerId,
      data: {
        name: this.name,
        phoneNumber: this.phoneNumber,
        flowId: this.flowId,
        enableVoiceSentiment: this.enableVoiceSentiment,
        ...(this.externalConfig && {
          externalConfig: parseObject(this.externalConfig),
        }),
        extractions: {
          [this.extractionsKey]: {
            type: this.extractionsType,
            description: this.extractionsDescription,
            required: this.extractionsRequired,
          },
        },
        ...(this.successCriteria && {
          successCriteria: parseObject(this.successCriteria),
        }),
      },
    });

    $.export(
      "$summary",
      `Successfully created voice deployment "${this.name}"`,
    );
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Brainbase Labs	`app`	`app`	This component uses the Brainbase Labs app.
Worker ID	`workerId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	Deployment name
Phone Number	`phoneNumber`	`string`	Phone number for deployment (e.g., +1234567890)
Flow ID	`flowId`	`string`	Select a value from the drop down menu.
Enable Voice Sentiment	`enableVoiceSentiment`	`boolean`	Enable voice sentiment analysis
External Config	`externalConfig`	`object`	External configuration object with voice settings, language, voiceId, etc. Example: `{"voice": "alloy", "language": "en"}`
Extractions Key	`extractionsKey`	`string`	The key of the extractions to use for the deployment
Extractions Type	`extractionsType`	`string`	Select a value from the drop down menu:`stringnumberboolean`
Extractions Description	`extractionsDescription`	`string`	The description of the extractions to use for the deployment
Extractions Required	`extractionsRequired`	`boolean`	Whether the extractions are required for the deployment
Success Criteria	`successCriteria`	`string[]`	Deployment success measurement criteria (optional)