Topview-api-English version
  1. Product Avatar
Topview-api-English version
  • API Document
  • Avatar Marketing Video
    • script
      • List script content
      • Update script content
    • Submit task
      POST
    • Query task
      GET
    • Export
      POST
  • Video Avatar
    • submit task
      POST
    • query task
      GET
  • Scraper
    • submit scraper task
      POST
    • query scraper task
      GET
  • Upload
    • Get Upload Credential
      GET
    • Get Upload Check
      GET
  • Product Avatar
    • Replace Product Image
      • submit task
      • query task
    • Image2Video
      • submit task
      • query task
    • Category Query
      GET
    • Public product avatar Query
      GET
  • Common Task
    • image2Video
      • submit task
      • query task
  • Product AnyShoot
    • Replace Product Image
      • submit task
      • query task
    • Template Category
      GET
    • Template List
      GET
  • Caption List
    GET
  • Voice Query
    GET
  • AiAvatar Query
    GET
  • check notice url
    POST
  • Ethnicity Query
    GET
  1. Product Avatar

Public product avatar Query

Developing
GET
/v1/product_avatar/public_avatar/query

Request

Query Params
ethnicityIds
string 
optional
ethnicityIds,separated by commas in English. The specific parameters of Interface Ethnicity Query
gender
enum<string> 
optional
male/female
Allowed values:
femalemale
sortingType
enum<string> 
optional
Allowed values:
PopularityNewest
categoryIds
string 
optional
categoryIds,separated by commas in English. The specific parameters of Interface Category Query
pageNo
string 
optional
Default value: 1
pageSize
string 
optional
Default value: 20
Header Params
Authorization
string 
required
Topview-Uid
string 
required

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.topview.ai/v1/product_avatar/public_avatar/query?ethnicityIds=&gender=&sortingType=&categoryIds=&pageNo=&pageSize=' \
--header 'Authorization;' \
--header 'Topview-Uid;'

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": [
            {
                "avatarId": "string",
                "avatarImagePath": "string",
                "voiceoverId": "string",
                "gender": "string",
                "avatarCategoryList": [
                    {
                        "categoryId": "string",
                        "categoryName": "string"
                    }
                ],
                "objectMaskImageInfo": "string",
                "avatarEthnicityList": [
                    {
                        "ethnicityId": "string",
                        "ethnicityName": "string"
                    }
                ],
                "minSubsType": "string"
            }
        ]
    }
}
Modified at 2025-06-10 07:52:12
Previous
Category Query
Next
submit task
Built with