/analyses/:analysis-id

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…

Analysis status

An analysis can have one of three statuses: pending, success, and failed.

All analyses start out pending while the requested analysis is carried out:

{ "id": "611457618c1d4283a830d10a9ad4f8ae", "status": "pending" }

If the analysis goes according to plan, the status changes to success after a short time, and outputs mirrors the elements of the predictions configuration, e.g.:

{ "id": "611457618c1d4283a830d10a9ad4f8ae", "status": "success", "outputs": { "attention": { "attentionMap": "https://s3.amazonaws.com/api-eyequant/..." }, "clarity": { "score": 71 } } }

In case an error occurs during analysis processing, the status of the analysis changes to failed:

{ "id": "611457618c1d4283a830d10a9ad4f8ae", "status": "failed", "error": { "code": "unreadable_input_image", "message": "We were unable to read the input image, either because the format is not supported, or because the image is truncated or corrupted." } }

Availability of analyses and results

Analyses become unavailable one hour after their success or failure (see also Result expiry). After this time, the request returns a 410 Gone response:

HTTP/1.1 410 Gone ... { "error": { "code": "resource_gone", "message": "This resource is no longer available." } }
Path Params
string
required

The analysis ID returned when it was created.

Responses

Language
Credentials
Request
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain