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.statusStringinit/running/success/fail
result.errorMsgString
result.costCreditIntegerCost in credits for the operation
result.bgRemovedImageFileIdStringUnique identifier for the background removed image
result.bgRemovedImagePathStringURL of the background removed image
result.bgRemovedImageWidthIntegerWidth of the background removed image
result.bgRemovedImageHeightIntegerHeight of the background removed image
result.maskImageFileIdStringUnique identifier for the mask image
result.maskImagePathStringURL of the mask image
result.maskImageWidthIntegerWidth of the mask image
result.maskImageHeightIntegerHeight of the mask image
Query Params
string
required
Defaults to 2eb4295e94c0441692cbe396c100d16e
string
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!