Create Video From Template with HeyGen API

Pipedream makes it easy to connect APIs for HeyGen and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Video From Template with the HeyGen 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 Video From Template with the HeyGen API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Video From Template action
1. Connect your HeyGen account
2. Select a Template ID
3. Optional- Configure Title
4. Optional- Configure Test
5. Optional- Configure Caption
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

Integrations#

Create Video From Template with HeyGen API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + HeyGen

Try it

Create Video From Template with HeyGen API on New Submission from Typeform API

Typeform + HeyGen

Try it

Create Video From Template with HeyGen API on Custom Events from Zoom API

Zoom + HeyGen

Try it

Create Video From Template with HeyGen API on New Submission (Instant) from Jotform API

Jotform + HeyGen

Try it

Create Video From Template with HeyGen API on New Scheduled Tasks from Pipedream API

Pipedream + HeyGen

Try it

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 Video From Template on HeyGen

Description:Generates a video from a selected template. [See the documentation](https://docs.heygen.com/reference/generate-template)

Version:0.0.1

Key:heygen-create-video-from-template

View on GitHub

Code#

import common from "../common/video-polling.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  ...common,
  key: "heygen-create-video-from-template",
  name: "Create Video From Template",
  description: "Generates a video from a selected template. [See the documentation](https://docs.heygen.com/reference/generate-template)",
  version: "0.0.1",
  type: "action",
  props: {
    ...common.props,
    templateId: {
      propDefinition: [
        common.props.heygen,
        "templateId",
      ],
      reloadProps: true,
    },
    title: {
      propDefinition: [
        common.props.heygen,
        "title",
      ],
      optional: true,
    },
    test: {
      propDefinition: [
        common.props.heygen,
        "test",
      ],
      optional: true,
    },
    caption: {
      propDefinition: [
        common.props.heygen,
        "caption",
      ],
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (!this.templateId) {
      return props;
    }
    try {
      const { data } = await this.heygen.getTemplate({
        templateId: this.templateId,
      });
      for (const [
        key,
        value,
      ] of Object.entries(data.variables)) {
        props[key] = {
          type: "string",
          label: `${key} Properties`,
          default: JSON.stringify(value.properties),
          optional: true,
        };
      }
      return props;
    } catch {
      throw new ConfigurationError("Template must contain variables.");
    }
  },
  methods: {
    ...common.methods,
    async processVideo($) {
      const { data: template } = await this.heygen.getTemplate({
        templateId: this.templateId,
        $,
      });
      const variables = {};
      for (const [
        key,
        value,
      ] of Object.entries(template.variables)) {
        let properties = value.properties;
        if (this[key]) {
          properties = typeof this[key] === "string"
            ? JSON.parse(this[key])
            : this[key];
        }
        variables[key] = {
          ...value,
          properties,
        };
      }
      const { data } = await this.heygen.generateVideoFromTemplate({
        templateId: this.templateId,
        data: {
          title: this.title,
          test: this.test,
          caption: this.caption,
          variables,
        },
        $,
      });
      return data.video_id;
    },
  },
};

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
HeyGen	`heygen`	`app`	This component uses the HeyGen app.
Template ID	`templateId`	`string`	Select a value from the drop down menu.
Title	`title`	`string`	Title of the video
Test	`test`	`boolean`	Set the test flag to `true` to use test mode. Generation in test mode will not cost your credits and will contain a watermark on your video.
Caption	`caption`	`boolean`	Set to `true` to create video with captions.