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

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

platform
enum<string>
default:open

Platform type - open for openapi, aigc for akool web app

Available options:
open,
aigc
page
integer
default:1

Page number for pagination

Required range: x >= 1
size
integer
default:100

Number of items per page (max 100)

Required range: 1 <= x <= 100

Response

200 - application/json

List of streaming avatars

code
integer
required

Interface returns business status code (1000: success)

Example:

1000

msg
string
required

Interface returns status information

Example:

"OK"

data
object