Actions15
Overview
The "Generate Photo" operation of the Photo Avatar resource in this node allows users to create AI-generated avatar photos based on detailed input parameters describing the desired appearance. This operation is useful for generating personalized avatars for profiles, marketing materials, games, or any application requiring custom human-like images without needing actual photographs.
Typical use cases include:
- Creating professional-looking avatars for social media or corporate profiles.
- Generating character images for storytelling, gaming, or virtual environments.
- Producing diverse avatar images with specific age, gender, ethnicity, and style attributes.
- Automating avatar creation workflows where manual photo shoots are impractical.
For example, a user can generate a "Young Adult Man" avatar with a "Realistic" style and a "Close Up" pose described as "Professional looking person with a warm smile." The node sends these details to an external API that returns the generated avatar image data.
Properties
| Name | Meaning |
|---|---|
| Name | Name assigned to the generated avatar. |
| Age | Age category of the avatar. Options: Young Adult, Early Middle Age, Late Middle Age, Senior, Unspecified. |
| Gender | Gender of the avatar. Options: Man, Woman, Unspecified. |
| Ethnicity | Ethnic background of the avatar. Options: White, Black, Asian American, East Asian, South East Asian, South Asian, Middle Eastern, Pacific, Hispanic, Unspecified. |
| Orientation | Image orientation of the avatar photo. Options: Vertical, Horizontal, Square. |
| Pose | Pose type of the avatar. Options: Close Up, Half Body, Full Body. |
| Style | Artistic style of the avatar image. Options: Realistic, Pixar, Cinematic, Vintage, Noir, Cyberpunk, Unspecified. |
| Appearance Description | A required textual description or prompt (up to 1000 characters) detailing the avatar's appearance, e.g., "Professional looking person with a warm smile", "Person with glasses wearing a business suit". |
| Callback URL | Optional URL to receive a notification when the avatar generation is completed. |
| Callback ID | Optional custom identifier to be sent back with the callback notification for tracking purposes. |
Output
The output JSON contains the response from the avatar generation API. Typically, this includes metadata about the generated avatar photo such as its unique identifiers, URLs to access the generated image, status information, and possibly other related data returned by the service.
If a callback URL is provided, the generation process may be asynchronous, and the final image will be delivered or notified via the callback mechanism.
No binary data is directly output by this operation; instead, references or URLs to the generated images are provided.
Dependencies
- Requires an active connection to the HeyGen API service.
- An API authentication token or key credential must be configured in n8n to authorize requests to the HeyGen API.
- Network connectivity to the HeyGen endpoints is necessary.
- Optional: If using callback URLs, a publicly accessible endpoint to receive notifications is needed.
Troubleshooting
- Missing or invalid API credentials: The node will fail if the API key or token is not set up correctly. Ensure credentials are properly configured in n8n.
- Invalid or incomplete input properties: Required fields like "Appearance Description" must be provided. Omitting mandatory fields will cause errors.
- Callback URL issues: If a callback URL is specified but unreachable or misconfigured, notifications will not be received. Verify the URL is correct and accessible.
- API rate limits or service downtime: The external API may reject requests due to rate limiting or outages. Check HeyGen service status and retry later if needed.
- Error messages from the API: These will be surfaced in the node output. Common errors relate to invalid parameter values or unsupported combinations (e.g., incompatible style and pose). Review the error message and adjust inputs accordingly.
Links and References
- HeyGen API Documentation (general reference for API capabilities)
- n8n Documentation (for configuring credentials and workflows)
- Avatar Generation Concepts (background on avatar usage)
This summary focuses exclusively on the "Generate Photo" operation of the "Photo Avatar" resource as requested, based on static analysis of the provided source code and property definitions.