Get avatar group details

Get detailed information about a single avatar group (character).

GET /v3/avatars/{group_id}

Get avatar group details

cURL

curl --request GET \
  --url https://api.heygen.com/v3/avatars/{group_id} \
  --header 'x-api-key: <api-key>'

200

{}

Authorizations

ApiKeyAuthBearerAuth

x-api-key · string · header · required

HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

group_id · string · required

Unique avatar group identifier

Response

200

application/json

Successful response

data · AvatarGroupItem · object

A single avatar group in the list response.

Groups are containers for looks (outfits/styles). To determine avatar type and engine compatibility, fetch the looks via GET /v3/avatars/looks.

Show child attributes