HeyGen icon

HeyGen

Consume HeyGen API

Photo Avatar → Get Avatar Details

AI-generated

Overview

This node operation retrieves detailed information about a specific photo avatar using its unique Avatar ID. It is useful for scenarios where you need to fetch and display or process the metadata and attributes of an existing photo avatar within the HeyGen platform.

Use Case Examples

  1. Fetch avatar details to display profile information in an application.
  2. Retrieve avatar metadata for auditing or management purposes.

Properties

Name Meaning
Avatar ID The unique identifier of the avatar whose details are to be retrieved.

Output

JSON

  • id - The unique identifier of the avatar.
  • name - The name of the avatar.
  • age - The age category of the avatar.
  • gender - The gender of the avatar.
  • ethnicity - The ethnicity of the avatar.
  • orientation - The orientation of the avatar image.
  • pose - The pose of the avatar.
  • style - The style applied to the avatar.
  • appearance - Description or prompt used to generate the avatar.
  • creationDate - The date when the avatar was created.
  • status - The current status of the avatar generation or availability.

Dependencies

  • HeyGen API key credential

Troubleshooting

  • Ensure the Avatar ID provided is correct and exists in the HeyGen system.
  • Check that the HeyGen API key credential is valid and has the necessary permissions.
  • If the API returns an error, verify network connectivity and API endpoint availability.

Links

Discussion