AiAvatar Query

Response

FieldTypeDescription
codeStringThe response code indicating status
messageStringMessage describing the response
resultObjectContains the result of the request
result.totalNumberTotal number of AI avatars available
result.pageNoNumberCurrent page number
result.pageSizeNumberNumber of items per page
result.dataArrayList of AI avatar objects
result.data[].aiavatarIdStringUnique identifier for the AI avatar
result.data[].aiavatarNameStringName of the AI avatar
result.data[].genderStringGender of the AI avatar (if available)
result.data[].coverUrlStringURL of the cover image for the AI avatar
result.data[].previewVideoUrlStringURL of the preview video for the AI avatar
result.data[].ethnicitiesStringEthnicities associated with the AI avatar (if available)
result.data[].voiceoverIdDefaultStringDefault voiceover ID for the AI avatar (if available)
result.data[].faceSquareConfigObjectConfiguration for the face square
result.data[].faceSquareConfig.y_fNumberY-coordinate in fractional format
result.data[].faceSquareConfig.wNumberWidth of the face square
result.data[].faceSquareConfig.hNumberHeight of the face square
result.data[].faceSquareConfig.xNumberX-coordinate in pixels
result.data[].faceSquareConfig.yNumberY-coordinate in pixels
result.data[].faceSquareConfig.h_fNumberHeight in fractional format
result.data[].faceSquareConfig.x_fNumberX-coordinate in fractional format
result.data[].faceSquareConfig.w_fNumberWidth in fractional format
Language
Click Try It! to start a request and see the response here!