AiAvatar Query - Topview-api-English version

Request

Query Params

pageNo

integer

optional

The page number. Default value: 1.

pageSize

integer

optional

The data size per page. Default value: 20.

gender

string

optional

male/female

ethnicityIdList

array[string]

optional

Ethnicity id list.

sortField

enum<string>

optional

Sort field. Default value：sort.

Allowed values:

sortshelvingTime

sortType

enum<string>

optional

Sort by decs/asc. Default: desc.

Allowed values:

ascdesc

isCustom

string

optional

私模数字人。默认值：false

Header Params

Topview-Uid

string

required

Example:

NsESlcgHzduRte5CcJn3

Authorization

string

required

Example:

Bearer sk-KKYbX8ac7EJ_9MvWXssSLKOkDT0_Dtwq7G6iGteJhxU

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.topview.ai/v1/aiavatar/query?pageNo=&pageSize=&gender=&ethnicityIdList&sortField&sortType&isCustom=' \
--header 'Topview-Uid: NsESlcgHzduRte5CcJn3' \
--header 'Authorization: Bearer sk-KKYbX8ac7EJ_9MvWXssSLKOkDT0_Dtwq7G6iGteJhxU'

Responses

🟢200OK

application/json

Body

code

string

required

message

string

required

result

object

required

total

integer

required

pageNo

integer

required

pageSize

integer

required

data

array [object {8}]

required

Example

{
    "code": "string",
    "message": "string",
    "result": {
        "total": 0,
        "pageNo": 0,
        "pageSize": 0,
        "data": [
            {
                "aiavatarId": "string",
                "aiavatarName": "string",
                "gender": "string",
                "coverUrl": "string",
                "previewVideoUrl": "string",
                "ethnicities": [
                    {
                        "ethnicityId": "string",
                        "ethnicityName": "string"
                    }
                ],
                "voiceoverIdDefault": "string",
                "faceSquareConfig": {
                    "y_f": 0,
                    "w": 0,
                    "h": 0,
                    "x": 0,
                    "y": 0,
                    "h_f": 0,
                    "x_f": 0,
                    "w_f": 0
                }
            }
        ]
    }
}