Avatar List

This is your first endpoint! Edit this page to start documenting your API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response

FieldTypeDescription
codeStringResponse code indicating success.
messageStringMessage describing the response.
resultObjectObject containing avatar data.
  • total
IntegerTotal number of avatars available.
  • pageNo
IntegerCurrent page number in the pagination.
  • pageSize
IntegerNumber of items per page.
  • data
ArrayArray of avatar data.
-- avatarIdStringUnique identifier for the avatar.
-- imageS3PathStringURL of the avatar image.
-- voiceIdStringUnique identifier for the voice associated with the avatar.
-- categoryListArrayList of categories associated with the avatar.
--- categoryIdStringUnique identifier for the category.
--- categoryNameStringName of the category.
Query Params
string
Defaults to 4ac8d232aa1945efaedf67b56ddf371d,b8e64f37db1c48a2aea904f3a2ae4522

Only isCustom=false, the categories are valid. Separate multiple categories with ",". Retrieve values from the interface Avatar Category List

boolean
enum
Allowed:
string
Defaults to 1
string
Defaults to 20
Headers
string
required
Defaults to <your-topview-uid>
string
required
Defaults to Bearer <your-api-key>
Response
200

Successful response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!