> ## Documentation Index
> Fetch the complete documentation index at: https://developers.eyequant.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> A REST API for generating visual attention heatmaps, clarity scores, and excitingness scores for images, web pages, and video.

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:

```text theme={null}
https://api.eyequant.com/v2
```

## Authentication

Every request must include your API key as a bearer token in the `Authorization` header:

```bash theme={null}
Authorization: Bearer $apikey
```

You can confirm your credentials and that the service is reachable with [Check API status](/api-reference/status). For full details, see [Authentication](/authentication).

## How analyses work

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

<Steps>
  <Step title="Submit">
    Create an analysis with [Create an analysis](/api-reference/create-analysis) (image or URL) or [Create a video analysis](/api-reference/create-video-analysis). The response returns an `id` immediately.
  </Step>

  <Step title="Poll">
    Retrieve the analysis by its `id` until `status` is `success` or `failed`. Poll every few seconds rather than in a tight loop.
  </Step>

  <Step title="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](/concepts/result-expiry).
  </Step>
</Steps>

<Tip>
  Every endpoint page below includes an interactive playground. Enter your API key once and send a real request straight from the docs.
</Tip>

## Endpoints

<CardGroup cols={2}>
  <Card title="Create an analysis" icon="play" href="/api-reference/create-analysis">
    Submit a web page URL or an uploaded image for analysis.
  </Card>

  <Card title="Get an analysis" icon="magnifying-glass" href="/api-reference/get-analysis">
    Poll for status and retrieve the output maps and scores.
  </Card>

  <Card title="Video analysis" icon="film" href="/api-reference/create-video-analysis">
    Run per-frame visual saliency analysis on a video.
  </Card>

  <Card title="Check API status" icon="signal" href="/api-reference/status">
    Verify your credentials and service availability.
  </Card>
</CardGroup>