Retrieve All Avatar Groups
GET
https://api.konpro.ai/v1/avatar_groupsReturns a list of avatar groups associated with your KonPro account, along with details about each group. Use the optional parameter to include public avatar groups in the results.
Request History
Log in to see full request history
| TIME | STATUS | USER AGENT |
|---|---|---|
| Make a request to see history. | ||
0 Requests This Month
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| include_public | boolean | If true, includes all public avatar groups; defaults false |
cURL Request
shell
curl --request GET \
--url 'https://api.konpro.ai/v1/avatar_groups?include_public=true' \
--header 'accept: application/json' \
--header 'x-api-key: <your-api-key>'Response
Response Structure
| Field | Type | Description |
|---|---|---|
| total_count | integer | The total number of avatar groups returned |
| avatar_groups | array | Collection of avatar group objects |
Each avatar group object contains:
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the avatar group |
| name | string | Display name of the group |
| created_at | float | Epoch timestamp (seconds) when the group was created |
| num_looks | integer | Number of avatars ("looks") within this group |
| preview_image | string | URL of the group's preview image |
| group_type | string | Type of group (e.g., "PUBLIC_PHOTO", "CUSTOM_GROUP") |
| train_status | string | Status of training for this group (empty if none) |
| default_voice_id | string | Default voice ID linked to avatars inside this group |
Sample Successful Response
json
{
"total_count": 2,
"avatar_groups": [
{
"id": "g123",
"name": "Marketing Team",
"created_at": 1682507380.0,
"num_looks": 5,
"preview_image": "https://cdn.konpro.ai/avatar_groups/marketing-team.jpg",
"group_type": "CUSTOM_GROUP",
"train_status": "",
"default_voice_id": "v001"
}
]
}Usage Notes
- The include_public query parameter controls whether global/public avatar groups are shown.
- API key authentication is required for all requests.
- Fields such as train_status and default_voice_id may be empty or absent depending on the group's state and configuration.
Example Usage
Shell
curl --request GET \
--url 'https://api.konpro.ai/v1/avatar_groups?include_public=true' \
--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