Heygen | By Mentor AI

Interact with Heygen API

Overview

This node interacts with the Heygen API to perform various operations related to avatar videos and assets. Specifically, the 'List Voices' operation retrieves a list of all available voices from Heygen. This is useful for users who want to see which voices they can use for generating avatar videos or other voice-related features. Practical applications include selecting a voice for text-to-speech avatar videos or exploring voice options for content creation.

Use Case Examples

  1. A user wants to generate a video with an avatar speaking a specific text and needs to choose a voice from the available options. They use the 'List Voices' operation to get the list of voices.
  2. A content creator wants to explore different voice options provided by Heygen before generating videos or audio content.

Output

JSON

  • id - Unique identifier of the voice
  • name - Name of the voice
  • language - Language of the voice
  • gender - Gender of the voice
  • additionalProperties - Other voice-related details returned by the API

Dependencies

  • Heygen API key credential required for authentication

Troubleshooting

  • Common issues include invalid or missing API key, resulting in authentication errors. Ensure the Heygen API key credential is correctly configured.
  • Network issues or incorrect API endpoint URLs can cause request failures. Verify network connectivity and API endpoint correctness.
  • If the operation is not supported or misspelled, the node throws an error indicating the unsupported operation. Ensure the operation parameter is set to 'listVoices' for this functionality.

Links

  • Heygen API Voices Documentation - Official documentation for the Heygen API voices endpoint, useful for understanding the data returned and available voice options.

Discussion