Overview
This node interacts with the Heygen API to perform various operations related to avatars, voices, videos, and assets. Specifically, the 'List Avatars' operation retrieves a list of all available avatars from the Heygen service. This is useful for users who want to see which avatars they can use for generating avatar videos or other media content.
Use Case Examples
- A user wants to fetch all available avatars to display them in a selection menu within their workflow.
- A content creator needs to list avatars to choose one for generating a personalized video.
Properties
| Name | Meaning |
|---|---|
| Operation | Specifies the action to perform; in this case, 'List Avatars' to retrieve all avatars. |
Output
JSON
- ``
id- The unique identifier of each avatar.name- The name of each avatar.description- Description or details about each avatar.image_url- URL to the avatar's image or thumbnail.
Dependencies
- Heygen API key credential required for authentication.
Troubleshooting
- Common issues include invalid or missing API key, resulting in authentication errors.
- Network issues or incorrect API endpoint URLs may cause request failures.
- If the operation parameter is incorrect or unsupported, the node throws an error indicating the operation is not supported.
Links
- Heygen API Documentation - Official documentation for Heygen API endpoints and usage.