Actions18
- Document Actions
- Photo Avatar Actions
- Video Actions
Photo Avatar → Generate Photo
AI-generatedOverview
This node operation generates a photo avatar using the HeyGen API. It allows users to specify various attributes for the avatar such as name, age, gender, ethnicity, orientation, pose, style, and a detailed appearance description. Optional callback URL and callback ID can be provided to receive notifications when the avatar generation is completed. This operation is useful for creating customized avatar images for profiles, marketing materials, or creative projects.
Use Case Examples
- Generate a professional-looking avatar with a warm smile for a business profile.
- Create an avatar with specific age, gender, and ethnicity attributes for a game character.
- Generate a Pixar-style avatar with a creative appearance description for social media use.
Properties
| Name | Meaning |
|---|---|
| Name | Name for the generated avatar. |
| Age | Age category for the generated avatar. |
| Gender | Gender for the generated avatar. |
| Ethnicity | Ethnicity for the generated avatar. |
| Orientation | Orientation for the generated avatar image. |
| Pose | Pose style for the generated avatar. |
| Style | Visual style for the generated avatar. |
| Appearance Description | Description or prompt detailing the appearance of the generated avatar photo. Examples include professional look, glasses, athletic, or creative artist styles. |
| Callback URL | Optional URL to receive a notification when avatar generation is completed. |
| Callback ID | Optional custom ID for callback purposes. |
Output
JSON
generationId- ID of the avatar generation job, used to track or check status.photoUrl- URL of the generated avatar photo.status- Status of the avatar generation process.
Dependencies
- HeyGen API with API key credential
Troubleshooting
- Ensure all required fields, especially 'Appearance Description', are provided to avoid errors.
- Check API key credentials and network connectivity if requests fail.
- If callback URL is used, ensure it is reachable and correctly configured to receive notifications.
Links
- HeyGen Photo Avatar API Documentation - Official API documentation for generating photo avatars with HeyGen.