HeyGen

Overview

This node interacts with the HeyGen API to manage and manipulate photo avatars. Specifically, the "Get Avatar Details" operation retrieves detailed information about a specific photo avatar by its ID. This is useful when you want to fetch metadata or status information about an existing avatar in your HeyGen account.

Common scenarios include:

• Retrieving avatar details for display or further processing in workflows.
• Verifying avatar creation or update status.
• Integrating avatar data into other systems or automations.

Example use case:

• After generating a photo avatar, you can use this operation to get its details such as creation time, appearance attributes, or URLs to the avatar images.

Properties

Output

The output JSON contains the detailed information about the specified photo avatar as returned by the HeyGen API. This typically includes metadata such as avatar attributes, status, image URLs, and other relevant properties describing the avatar.

No binary data output is produced by this operation.

Dependencies

• Requires an active connection to the HeyGen API via an API key credential configured in n8n.
• The node uses the HeyGen API version 2 endpoints.
• Network access to HeyGen's API endpoints is necessary.

Troubleshooting

• Error: Missing or invalid Avatar ID
  Ensure that the "Avatar ID" property is provided and correctly references an existing avatar.

• API request failures (e.g., 401 Unauthorized, 404 Not Found)
  Verify that the API key credential is valid and has sufficient permissions. Confirm the avatar ID exists in your HeyGen account.

• Network errors or timeouts
  Check network connectivity and HeyGen service status.

• Unexpected response structure
  If the API changes, the node might not parse responses correctly. Review HeyGen API documentation for updates.

Links and References

• HeyGen API Documentation (general reference for API endpoints and usage)
• HeyGen Photo Avatar API Reference (specific to photo avatar operations)