Actions15
Overview
The "Create Avatar Group" operation in the Photo Avatar resource allows users to create a new avatar group by specifying a group name and an image key. Optionally, a generation ID can be provided if the group is related to a specific image generation job. This node operation is useful for organizing multiple avatars into groups, which can then be managed or trained collectively. For example, a user might create an avatar group representing a team or a character set for a project.
Properties
| Name | Meaning |
|---|---|
| Group Name | The name assigned to the avatar group being created. |
| Image Key | A unique key identifying the image associated with the avatar group. |
| Generation ID | (Optional) The ID of the generation job used to generate the image for this avatar group. |
Output
The output JSON contains the response from the HeyGen API after creating the avatar group. This typically includes details about the newly created group such as its ID, name, image key, and possibly status or metadata returned by the API. The exact structure depends on the API response but generally confirms successful creation and provides identifiers for further operations.
This node does not output binary data.
Dependencies
- Requires an active connection to the HeyGen API.
- Requires an API authentication token credential configured in n8n to authorize requests.
- The node uses the HeyGen API endpoint
/photo_avatar/avatar_group/createwith HTTP POST method.
Troubleshooting
- Missing Required Fields: If "Group Name" or "Image Key" is not provided, the API call will fail. Ensure these required fields are filled.
- Invalid Generation ID: Providing an incorrect or invalid generation ID may cause the API to reject the request or ignore the field.
- API Authentication Errors: If the API key credential is missing or invalid, the node will throw authentication errors. Verify that the API key is correctly configured.
- Network Issues: Connectivity problems to the HeyGen API endpoint will result in request failures. Check network access and proxy settings if applicable.
- Unexpected API Response: If the API changes or returns unexpected data, the node might fail to parse the response properly.
Links and References
- HeyGen API Documentation (general reference for API endpoints and usage)
- n8n documentation on Creating Custom Nodes