Get All Avatars
GET
/v1/avatarsRetrieve a list of all available avatars.
Request History
Log in to see full request history
| TIME | STATUS | USER AGENT |
|---|---|---|
| Make a request to see history. | ||
0 Requests This Month
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| scope | string | Filter avatars by scope. Options: all, public, private |
| page | integer | Page number for pagination (default: 1) |
| limit | integer | Number of items per page (default: 20) |
Request Example
shell
curl -X GET https://api.konpro.ai/v1/avatars \
-H "x-api-key: <your-api-key>" \
-H "Content-Type: application/json"Response
Avatars Array
avatars: An array containing avatar details.
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier of the avatar |
| name | string | Name of the avatar |
| thumbnail_url | string | URL to the avatar thumbnail image |
| video_url | string | URL to the avatar preview video |
| created_at | string | ISO 8601 timestamp of when the avatar was created |
| scope | string | Scope of the avatar: public or private |
Pagination Object
pagination: Pagination information for the response.
| Field | Type | Description |
|---|---|---|
| page | integer | Current page number |
| limit | integer | Number of items per page |
| total | integer | Total number of avatars |
| total_pages | integer | Total number of pages |
Sample Successful Response
json
{
"avatars": [
{
"id": "avatar-3655",
"name": "Avatar Name",
"thumbnail_url": "https://...",
"video_url": "https://...",
"created_at": "2024-01-01T00:00:00Z",
"scope": "public"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 100,
"total_pages": 5
}
}Notes
- This endpoint requires authentication using the
x-api-keyheader. - Use the
scopeparameter to filter avatars by visibility (all, public, private). - Results are paginated. Use
pageandlimitparameters to navigate through results. - For error descriptions, see Error Responses.