Skip to main content
The EyeQuant API is a REST API that runs machine-perception models on your designs and returns visual attention heatmaps, clarity scores, and excitingness scores. Use it to analyze a live web page, an uploaded image, or a video.

​
Base URL

All endpoints are served under a single versioned base URL: 
https://api.eyequant.com/v2

​
Authentication

Every request must include your API key as a bearer token in the Authorization header: 
Authorization: Bearer $apikey
You can confirm your credentials and that the service is reachable with Check API status. For full details, see Authentication.

​
How analyses work

Analyses are processed asynchronously, so working with the API follows a three-step lifecycle:
1

Submit

Create an analysis with Create an analysis (image or URL) or Create a video analysis. The response returns an id immediately.
2

Poll

Retrieve the analysis by its id until status is success or failed. Poll every few seconds rather than in a tight loop.
3

Download

On success, download the output maps from the URLs in the outputs object and store them on your own infrastructure — the links are time-limited. See Result expiry.
Every endpoint page below includes an interactive playground. Enter your API key once and send a real request straight from the docs.

​
Endpoints

Create an analysis

Submit a web page URL or an uploaded image for analysis.

Get an analysis

Poll for status and retrieve the output maps and scores.

Video analysis

Run per-frame visual saliency analysis on a video.

Check API status

Verify your credentials and service availability.