List All Avatars in an Avatar Group
GET
https://api.konpro.ai/v1/avatar_groups/{group_id}/avatarsFetch all avatars contained within a specific avatar group by providing the group's unique identifier.
Request History
Log in to see full request history
| TIME | STATUS | USER AGENT |
|---|---|---|
| Make a request to see history. | ||
0 Requests This Month
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| group_id | string | The unique ID of the avatar group (required) |
cURL Request
shell
curl --request GET \
--url https://api.konpro.ai/v1/avatar_groups/<group_id>/avatars \
--header 'accept: application/json' \
--header 'x-api-key: <your-api-key>'Response
Response Structure
| Field | Type | Description |
|---|---|---|
| avatar_list | array | Array of avatar objects in the specified group |
Each avatar object includes:
| Field | Type | Description |
|---|---|---|
| id | string | Unique avatar ID |
| image_url | string | Direct URL to the avatar image |
| created_at | float | Timestamp (in seconds) indicating when the avatar was created |
| name | string | Designation or look name of the avatar |
| status | string | Current processing status (e.g., "completed") |
| group_id | string | Identifier of the avatar group this avatar belongs to |
| is_motion | boolean | Indicates if avatar is animated or motion-enabled |
| motion_preview_url | string or null | URL to preview motion avatar, or null if not available |
| business_type | string | Classification such as "generated" |
| upscale_availability | object | Details on whether upscaling is supported |
| — available | boolean | True if upscaling is possible |
| — reason | string | Reason if upscaling unavailable |
| upscaled | boolean | Whether the avatar has been upscaled |
| background_sound_effect | string or null | Background sound effect applied, if any |
| default_voice_id | string | Default voice ID associated with this avatar |
Example Usage
Shell
curl --request GET \
--url https://api.konpro.ai/v1/avatar_groups/<group_id>/avatars \
--header 'accept: application/json' \
--header 'x-api-key: <your-api-key>'LANGUAGE
CREDENTIALS
HEADER
RESPONSE
Examples
Choose an example:
application/json
200 - Result
400 - Result
LANGUAGE
CREDENTIALS
HEADER
RESPONSE
Examples
Choose an example:
application/json
200 - Result
400 - Result