Heygen | By Mentor AI

Interact with Heygen API
Join our community

Actions5

Overview

This node interacts with the Heygen API to generate avatar videos where an avatar speaks provided text with a selected voice. It supports generating videos with customizable background colors and video dimensions. This is useful for creating personalized video content, marketing materials, or virtual presentations using avatars.

Use Case Examples

  1. Generate a promotional video with a specific avatar and voice, speaking a marketing message.
  2. Create a personalized greeting video with a chosen avatar and voice, customizing the background and video size.

Properties

Name Meaning
Avatar ID ID of the avatar to use for the video.
Voice ID ID of the voice to use for the video.
Input Text Text for the avatar to speak in the video.
Background Background color of the video in hex format (e.g., #f6f6fc).
Video Dimension Dimension of the output video.

Output

JSON

  • video_inputs - Details of the video inputs including avatar, voice, and background.
  • dimension
    • width - Width of the output video.
    • height - Height of the output video.
  • video_id - ID of the generated video (if returned by API).
  • status - Status of the video generation process (if returned by API).

Dependencies

  • Heygen API key credential required for authentication.

Troubleshooting

  • Common issues include invalid or missing API key, incorrect avatar or voice IDs, and network connectivity problems.
  • Error messages may indicate unsupported operations if an invalid operation is selected.
  • Ensure the input text is provided and not empty to avoid API errors.
  • Background color must be in valid hex format; invalid formats may cause request failures.

Links

Discussion