HeyGen icon

HeyGen

Consume HeyGen API

Actions18

Photo Avatar → Create Avatar Group

AI-generated

Overview

This node operation creates a new avatar group within the HeyGen platform's Photo Avatar resource. It allows users to organize avatars by grouping them under a specified group name and associating an image key with the group. Optionally, a generation ID can be provided to link the group to a specific image generation process. This operation is useful for managing and categorizing avatars in projects involving AI-generated photo avatars.

Use Case Examples

  1. Creating an avatar group named 'Team Leaders' with a specific image key to organize avatars representing team leaders in a corporate project.
  2. Grouping avatars generated from a particular image generation job by providing the generation ID to track their origin.

Properties

Name Meaning
Group Name Name for the avatar group, used to identify and label the group.
Image Key Image key for the avatar group, used to associate a representative image with the group.
Generation ID Optional generation ID used to link the avatar group to a specific image generation process.

Output

JSON

  • id - Unique identifier of the created avatar group.
  • name - Name of the avatar group.
  • image_key - Image key associated with the avatar group.
  • generation_id - Generation ID linked to the avatar group, if provided.
  • created_at - Timestamp when the avatar group was created.

Dependencies

  • HeyGen API key credential for authentication

Troubleshooting

  • Ensure that the 'Group Name' and 'Image Key' fields are provided and not empty, as they are required.
  • If a 'Generation ID' is provided, verify that it corresponds to a valid image generation job in HeyGen.
  • Check API key credentials and network connectivity if the request to create the avatar group fails.
  • Common error messages may include missing required fields or invalid generation ID; verify input values accordingly.

Links

Discussion