Query Task

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
codeStringThe response code indicating status
messageStringMessage describing the response
resultObjectContains the result of the request
result.taskIdStringUnique identifier for the task
result.statusStringStatus of the task
result.errorMsgString or nullError message if any error occurred
result.aiAvatarObjectObject containing details of the AI avatar
result.aiAvatar.aiavatarIdStringUnique identifier for the AI avatar
result.aiAvatar.aiavatarNameStringName of the AI avatar
result.aiAvatar.genderString or nullGender of the AI avatar (if applicable)
result.aiAvatar.coverUrlStringURL of the cover image for the AI avatar
result.aiAvatar.previewVideoUrlStringURL of the preview video for the AI avatar
result.aiAvatar.ethnicitiesString or nullEthnicities of the AI avatar (if applicable)
result.aiAvatar.voiceoverIdDefaultString or nullDefault voiceover ID for the AI avatar
result.aiAvatar.faceSquareConfigObject or nullConfiguration for face square (if applicable)
Query Params
string
required
Defaults to cdadc677d5a441fbb913070f4cba5e0c
boolean
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!