Get Avatar Details

GEThttps://api.konpro.ai/v1/avatars/{avatar_id}/details

Fetch detailed information for a specific avatar by providing its unique avatar ID. The response includes metadata such as the avatar's name, gender, preview media URLs, voice associations, tags, and availability status.

Request History

TIME	STATUS	USER AGENT
Make a request to see history.

0 Requests This Month

Path Parameter

Parameter	Type	Description
avatar_id	string	Unique identifier for the avatar (required)

cURL Request

shell

curl --request GET \
--url https://api.konpro.ai/v1/avatars/<avatar_id>/details \
--header 'accept: application/json' \
--header 'x-api-key: <your-api-key>'

Response

Response Structure

Field	Type	Description
error	string	Error message if the request fails; null if successful
data	object	Object containing the avatar's detail information

Inside data object:

Field	Type	Description
type	string	Resource type; always "avatar"
id	string	Unique avatar ID
name	string	Display name of the avatar
gender	string	Gender associated with the avatar ("male" or "female")
preview_image_url	string	URL to a preview image of the avatar
preview_video_url	string	URL to a preview video showcasing the avatar
premium	boolean	Indicates if the avatar is marked as premium
is_public	boolean	Shows whether the avatar is publicly accessible
default_voice_id	string	Default voice ID configured for this avatar
tags	array	List of tags describing the avatar's attributes or categories

Example Usage

Shell

curl --request GET \
--url https://api.konpro.ai/v1/avatars/<avatar_id>/details \
--header 'accept: application/json' \
--header 'x-api-key: <your-api-key>'

LANGUAGE

CREDENTIALS

Header

HEADER

RESPONSE

Examples

Choose an example:

application/json

200 - Result

400 - Result

List All Avatars in one avatar group Create Avatar Video