Skip to main content
GET
/
v3
/
avatars
List avatar groups
curl --request GET \
  --url https://api.heygen.com/v3/avatars \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "created_at": 123,
      "looks_count": 123,
      "preview_image_url": "https://files.heygen.ai/avatar/anna_preview.jpg",
      "preview_video_url": "https://files.heygen.ai/avatar/anna_preview.mp4",
      "gender": "female",
      "default_voice_id": "1bd001e7e50f421d891986aad5c8bbd2",
      "consent_status": "approved"
    }
  ],
  "has_more": true,
  "next_token": "<string>"
}

Authorizations

​
x-api-key
string
header
required

HeyGen API key. Obtain from your HeyGen dashboard.

Query Parameters

​
ownership
enum<string>

Filter by ownership: 'public' for preset avatars, or 'private' for your own. Omit for all.

Available options:
public,
private
​
limit
integer
default:20

Maximum number of items to return per page (1-50).

Required range: 1 <= x <= 50
​
token
string

Opaque cursor token for the next page.

Response

Successful response

​
data
AvatarGroupItem · object[]
​
has_more
boolean

Whether more pages are available

​
next_token
string | null

Opaque cursor for the next page