HeyGen icon

HeyGen

Consume HeyGen API

Actions18

Video → Create Video

AI-generated

Overview

This node operation creates a video using the HeyGen API. It allows users to configure various video settings such as caption inclusion, title, callback options, output folder, video dimensions, and multiple video input scenes. Each video input scene can specify character type (avatar or talking photo), voice type (text, audio, or silence), background type (color, image, or video), and other detailed parameters to customize the video content. This operation is useful for generating AI-driven videos with customizable avatars or talking photos, suitable for marketing, presentations, or content creation.

Use Case Examples

  1. Creating a video with an avatar character speaking a scripted text with a colored background.
  2. Generating a video with multiple scenes, each having different avatars or talking photos with various voice inputs and background settings.

Properties

Name Meaning
Caption Whether to add a caption to the video. Only text input supports caption.
Title Title for the video.
Callback ID A custom ID for callback purposes.
Callback URL An optional callback URL to receive a notification when the video is ready.
Folder ID Specify the video output folder destination.
Video Dimensions The dimensions of the output video, including width and height in pixels.
Video Input Scenes Video input settings describing each scene in the video, including character type, voice type, background type, and related parameters.

Output

JSON

  • id - ID of the created video.
  • status - Status of the video creation process.
  • title - Title of the created video.
  • callback_id - Callback ID associated with the video.
  • callback_url - Callback URL for video readiness notification.
  • folder_id - Folder ID where the video is stored.
  • dimension
    • width - Width of the video in pixels.
    • height - Height of the video in pixels.
  • video_inputs - Array of video input scenes with character, voice, and background details.

Dependencies

  • HeyGen API with API key credential

Troubleshooting

  • Ensure at least one video input scene is provided; otherwise, the node throws an error.
  • Verify that the callback URL and callback ID are correctly formatted if used.
  • Check that video dimensions are valid numbers and within supported ranges.
  • Confirm that avatar IDs and talking photo IDs are valid and exist in the HeyGen system.

Links

  • HeyGen API Documentation - Official API documentation for HeyGen, detailing endpoints and parameters for video creation.

Discussion