get
https://api.heygen.com/v1/streaming/avatar.list
This API endpoint allows you to retrieve a list of public and custom interactive avatars.
Interactive Avatar is getting upgraded to LiveAvatar! Now with its own website and app. Learn more
We recommend integrating directly with LiveAvatar instead. Docs
Response Body
| Field | Type | Description |
|---|---|---|
code | integer | Status code of the response (e.g., 100 for success). |
data | array | Array of avatar objects. |
data.avatar_id | string | Unique identifier for the avatar. |
data.created_at | integer | Timestamp when the avatar was created. |
data.default_voice | string | Default voice ID associated with the avatar. |
data.is_public | boolean | Indicates whether the avatar is public. |
data.normal_preview | string | URL for a preview image of the avatar. |
data.pose_name | string | Human-readable name or description of the avatar. |
data.status | string | Current status of the avatar (e.g., ACTIVE, INACTIVE). |
message | string | Response message (e.g., "Success"). |