get https://api.topview.ai/v1/aiavatar/query
Response
Field | Type | Description |
---|---|---|
code | String | The response code indicating status |
message | String | Message describing the response |
result | Object | Contains the result of the request |
result.total | Number | Total number of AI avatars available |
result.pageNo | Number | Current page number |
result.pageSize | Number | Number of items per page |
result.data | Array | List of AI avatar objects |
result.data[].aiavatarId | String | Unique identifier for the AI avatar |
result.data[].aiavatarName | String | Name of the AI avatar |
result.data[].gender | String | Gender of the AI avatar (if available) |
result.data[].coverUrl | String | URL of the cover image for the AI avatar |
result.data[].previewVideoUrl | String | URL of the preview video for the AI avatar |
result.data[].ethnicities | String | Ethnicities associated with the AI avatar (if available) |
result.data[].voiceoverIdDefault | String | Default voiceover ID for the AI avatar (if available) |
result.data[].faceSquareConfig | Object | Configuration for the face square |
result.data[].faceSquareConfig.y_f | Number | Y-coordinate in fractional format |
result.data[].faceSquareConfig.w | Number | Width of the face square |
result.data[].faceSquareConfig.h | Number | Height of the face square |
result.data[].faceSquareConfig.x | Number | X-coordinate in pixels |
result.data[].faceSquareConfig.y | Number | Y-coordinate in pixels |
result.data[].faceSquareConfig.h_f | Number | Height in fractional format |
result.data[].faceSquareConfig.x_f | Number | X-coordinate in fractional format |
result.data[].faceSquareConfig.w_f | Number | Width in fractional format |