Skip to main content
GET
/
api
/
open
/
v4
/
liveAvatar
/
avatar
/
detail
Get Streaming Avatar Detail
curl --request GET \
  --url https://openapi.akool.com/api/open/v4/liveAvatar/avatar/detail \
  --header 'x-api-key: <api-key>'
{
  "code": 1000,
  "msg": "OK",
  "data": {
    "_id": "<string>",
    "uid": 123,
    "type": 123,
    "from": 123,
    "avatar_id": "<string>",
    "voice_id": "<string>",
    "name": "<string>",
    "url": "<string>",
    "thumbnailUrl": "<string>",
    "gender": "<string>",
    "available": true,
    "platform": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded.

Query Parameters

avatar_id
string
required

Unique identifier for the streaming avatar

Response

200 - application/json

Avatar details

code
integer
required

Interface returns business status code (1000: success)

Example:

1000

msg
string
required

Interface returns status information

Example:

"OK"

data
object