Query Task(Product Model)

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
codeStringResponse code indicating success.
messageStringMessage describing the response.
taskIdStringUnique identifier for the task.
statusStringStatus of the task, indicating success or failure.
errorMsgStringError message if applicable (empty if no error).
costCreditFloatCost in credits for the task.
anyfitImagesArrayArray of images related to the task.
  • key
StringUnique identifier for the image.
  • url
StringURL of the image.
Query Params
string
required
boolean
enum
Defaults to false

Default false. Whether to return a CloudFront URL: true - returns the CloudFront URL; false - will return the S3 URL

Allowed:
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!