get https://api.heygen.com/v2/avatar_group//avatars
List all avatars in one avatar group
Response
Field | Type | Description |
---|---|---|
avatar_list | List of avatars in the group. | |
avatar_list[].id | string | Unique identifier for the avatar. |
avatar_list[].image_url | string | URL of the avatar image. |
avatar_list[].created_at | float | Timestamp (in seconds) when the avatar was created. |
avatar_list[].name | string | Name of the avatar look. |
avatar_list[].status | string | Status of the avatar. Example: completed . |
avatar_list[].group_id | string | Identifier of the group this avatar belongs to. |
avatar_list[].is_motion | boolean | Whether the avatar is a motion avatar. |
avatar_list[].motion_preview_url | string | null | URL for the motion avatar preview. null if not available. |
avatar_list[].business_type | string | Business type of the avatar. Example: generated . |
avatar_list[].upscale_availability | Upscale availability information. | |
avatar_list[].upscale_availability.available | boolean | Whether the avatar is available for upscaling. |
avatar_list[].upscale_availability.reason | string | Reason why upscaling is not available (if applicable). |
avatar_list[].upscaled | boolean | Whether the avatar has been upscaled. |
avatar_list[].background_sound_effect | string | null | Background sound effect applied to the avatar. null if none. |
avatar_list[].default_voice_id | string | Default voice ID assigned to this avatar. |