HeyGen icon

HeyGen

Consume HeyGen API

Overview

The "Upscale Avatar" operation in the Photo Avatar resource allows users to enhance the resolution and quality of an existing avatar image. This is useful when you want a higher-definition version of an avatar for better visual presentation, such as marketing materials, profile pictures, or digital content where clarity is important.

Typical scenarios include:

  • Improving the detail of avatars generated previously.
  • Preparing avatars for print or high-resolution displays.
  • Enhancing avatars before using them in videos or animations.

For example, if you have created a photo avatar but find it too low-res for your website banner, you can use this operation to upscale it to a sharper, more detailed image.

Properties

Name Meaning
Avatar ID The unique identifier of the avatar to be upscaled. This property is required.

Output

The node outputs JSON data representing the response from the HeyGen API after requesting the avatar upscale. This typically includes details about the upscaled avatar, such as new image URLs or status information.

No binary data output is indicated for this operation; the output is purely JSON metadata related to the upscaling process.

Dependencies

  • Requires an active connection to the HeyGen API service.
  • Requires an API authentication token configured in n8n credentials (referred generically as "an API key credential").
  • Network access to HeyGen endpoints is necessary.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Avatar ID will likely cause errors.
    • Network connectivity problems may prevent successful API calls.
    • Missing or incorrect API credentials will result in authentication failures.
  • Error messages:

    • Errors indicating missing Avatar ID mean the input property was not set or was empty.
    • Authentication errors suggest that the API key credential is missing or invalid.
    • API rate limits or service downtime may cause request failures; retrying later or checking service status is recommended.

Links and References

  • HeyGen API Documentation (general reference): HeyGen API Docs (Note: link provided as a placeholder since exact URL is not in source)

Discussion