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.videosArrayList of videos generated
result.videos[originVideo]ObjectObject containing details of the original video
result.videos[originVideo.filePath]StringURL of the original video
result.videos[originVideo.width]IntegerWidth of the original video
result.videos[originVideo.height]IntegerHeight of the original video
result.costCreditFloatCost in credits for the task
Query Params
string
required
Defaults to f44c0c8e68514cd4a0135cb3d1c2973f
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!