> ## 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.

# EyeQuant: Predictive Visual Attention for Any Design

> EyeQuant is a machine perception API that generates attention heatmaps, clarity scores, and excitingness scores for images and web pages.

Everything EyeQuant does in the app is available through the API. Send a design — an image, a live URL, or a video — and get back the same attention heatmaps, scores, and recommendations your team already trusts, in seconds. No user studies, no eye-tracking hardware, no waiting for traffic.

Use it to validate creative before it ships, score every asset in your pipeline automatically, or build visual intelligence straight into your own product.

## What you can analyze

<CardGroup cols={3}>
  <Card title="Images" icon="image">
    Upload a PNG or JPEG (Base64) to analyze any static design, mockup, or asset — even ones that aren't publicly hosted.
  </Card>

  <Card title="URLs" icon="link">
    Pass any public URL. EyeQuant captures the screenshot for you — desktop, mobile, or generic viewport — then runs the analysis.
  </Card>

  <Card title="Video" icon="film">
    Submit a video for frame-by-frame attention analysis of motion content and ads.
  </Card>
</CardGroup>

## What you get back

Every analysis runs the same machine-perception models behind the EyeQuant app, returned as clean JSON with time-limited links to rendered maps.

<CardGroup cols={2}>
  <Card title="Attention" icon="eye">
    A heatmap of where viewers look first. Outputs: `attentionMap`, `perceptionMap`, `hotspotsMap`.
  </Card>

  <Card title="Clarity" icon="gauge">
    A 0–100 score for how clear and easy to process a design is, with a supporting map.
  </Card>

  <Card title="Excitingness" icon="bolt">
    A 0–100 score for the visual and emotional impact of a design.
  </Card>

  <Card title="Ad Visibility" icon="bullseye">
    A score for how well a creative stands out and captures attention in context.
  </Card>
</CardGroup>

Need words, not just numbers? Generate an [AI summary](/api-reference/get-summary) and [actionable recommendations](/api-reference/get-recommendations) for any analysis.

## Why build on EyeQuant

Attention prediction normally takes years of neuroscience R\&D and millions of eye-tracking data points to get right. EyeQuant's models are already there — trained on real eye-tracking research spanning more than 20,000 experiments and 1.6 million data points. You get tested, accurate visual intelligence you can integrate today, instead of building it from scratch.

## How it works

The API is REST over HTTPS, JSON in and JSON out, authenticated with a bearer token. Analyses run asynchronously: submit a design, poll for the result, then download the maps and scores.

<CardGroup cols={3}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Run your first analysis end to end in a few minutes.
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    Add your API key to every request.
  </Card>

  <Card title="API reference" icon="code" href="/api-reference/overview">
    Every endpoint, with an interactive playground.
  </Card>
</CardGroup>

## Getting API access

API credentials aren't self-serve — contact [sales@eyequant.com](mailto:sales@eyequant.com) to request your key. Then head to [Authentication](/authentication) to start making calls.

<Note>
  Store your API key securely — in an environment variable or secrets manager — and never commit it to source control.
</Note>