HeyGen icon

HeyGen

Consume HeyGen API

Overview

The "Generate Avatar Looks" operation in the Photo Avatar resource allows users to create multiple avatar looks based on an existing avatar group. By providing a textual prompt and optional parameters such as orientation, pose, and style, this operation generates different visual variations or "looks" for avatars within the specified group.

This node is beneficial when you want to quickly generate diverse avatar appearances for creative projects, marketing materials, games, or virtual environments without manually designing each look. For example, you could generate several stylistic variations of a character (e.g., realistic, cyberpunk, vintage) or different poses and orientations to use in animations or profile pictures.

Properties

Name Meaning
Group ID The unique identifier of the avatar group for which new looks will be generated.
Prompt A descriptive text prompt guiding the generation of different avatar looks.
Orientation The layout orientation of the generated avatar looks. Options: Vertical, Horizontal, Square.
Pose The pose style of the avatar looks. Options: Close Up, Half Body, Full Body.
Style The artistic style applied to the avatar looks. Options: Realistic, Pixar, Cinematic, Vintage, Noir, Cyberpunk, Unspecified.

Output

The output JSON contains the response from the HeyGen API endpoint /photo_avatar/look/generate. This typically includes details about the generated avatar looks such as their IDs, URLs, metadata, or status information depending on the API's response structure.

If the node supports binary data output (not explicitly shown here), it would represent image files or related media for the generated avatar looks. However, this operation primarily returns JSON metadata describing the generated looks.

Dependencies

  • Requires an active connection to the HeyGen API with valid API authentication credentials.
  • The node uses the HeyGen API version 2 endpoints.
  • No additional environment variables are explicitly required beyond the API key credential configuration.
  • Network access to HeyGen API endpoints is necessary.

Troubleshooting

  • Missing or invalid Group ID: Ensure the provided Group ID corresponds to an existing avatar group in your HeyGen account.
  • Empty or unclear Prompt: The prompt should clearly describe the desired avatar looks; vague prompts may lead to unsatisfactory results.
  • API errors: If the HeyGen API returns errors, verify that your API key is valid and has sufficient permissions.
  • Rate limits: Excessive requests might trigger rate limiting; consider adding delays or retries.
  • Invalid option values: Make sure the Orientation, Pose, and Style options are set to one of the supported values listed above.
  • Network issues: Check your internet connection and firewall settings if requests fail to reach the HeyGen API.

Links and References

Discussion