Get Single Avatar
GET
/v1/avatars/{avatar_id}Retrieve details of a specific avatar.
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 |
|---|---|---|
| avatar_id | string | The unique identifier of the avatar |
Request Example
shell
curl -X GET https://api.konpro.ai/v1/avatars/{avatar_id} \
-H "x-api-key: <your-api-key>" \
-H "Content-Type: application/json"Response
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier of the avatar |
| name | string | Name of the avatar |
| description | string | Description of the avatar |
| thumbnail_url | string | URL to the avatar thumbnail image |
| video_url | string | URL to the avatar preview video |
| properties | object | Avatar properties object containing gender, age_range, and style |
| created_at | string | ISO 8601 timestamp of when the avatar was created |
| updated_at | string | ISO 8601 timestamp of when the avatar was last updated |
Properties Object
| Field | Type | Description |
|---|---|---|
| gender | string | Gender of the avatar (e.g., female) |
| age_range | string | Age range of the avatar (e.g., 25-35) |
| style | string | Style of the avatar (e.g., professional) |
Sample Successful Response
json
{
"id": "avatar-3655",
"name": "Avatar Name",
"description": "Avatar description",
"thumbnail_url": "https://...",
"video_url": "https://...",
"properties": {
"gender": "female",
"age_range": "25-35",
"style": "professional"
},
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}Notes
- This endpoint requires authentication using the
x-api-keyheader. - Replace
{avatar_id}in the URL with the actual avatar ID you want to retrieve. - The
avatar_idmust be a valid avatar ID from your account or a public avatar. - For error descriptions, see Error Responses.