Query Task

Query the status and result of a Photo Avatar task by taskId. Recommended polling interval 3-5 seconds, timeout 5 minutes.

Task status (status): init submitted and waiting; running processing; success succeeded; fail failed (errorMsg contains the reason).

Credits: costCredit is the credits consumed by this task (float). Settled on success, fully refunded on failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Task ID (returned by the submit endpoint)

boolean
Defaults to false

Whether to return CloudFront access URLs, default false

Headers
string
required
Defaults to <your-topview-uid>

User ID

string
required
Defaults to Bearer <your-api-key>

API key, format: Bearer {apiKey}

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json