> ## 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 API documentation

> Embed predictive visual attention into your product — attention heatmaps, clarity and excitingness scores, ad visibility, and AI recommendations, all over a simple REST API.

Everything EyeQuant does in the app is available through a simple REST API. Send a design — an image, a live URL, or a video — and get back attention heatmaps, clarity and excitingness scores, ad visibility, and AI-written recommendations, in seconds. No user studies, no eye-tracking hardware, no traffic required.

<CardGroup cols={2}>
  <Card title="Introduction" icon="book-open" href="/introduction">
    What EyeQuant measures, what you can analyze, and why build on it.
  </Card>

  <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 bearer API key to every request.
  </Card>

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

  <Card title="Guides" icon="lightbulb" href="/guides/analyzing-urls">
    Walkthroughs for analyzing URLs, images, and videos.
  </Card>

  <Card title="Core concepts" icon="eye" href="/concepts/input-model">
    Inputs, predictions, formats, and result handling.
  </Card>
</CardGroup>

## What you can measure

<CardGroup cols={2}>
  <Card title="Attention" icon="eye" href="/concepts/predictions-model">
    Heatmaps of where viewers look first — `attentionMap`, `perceptionMap`, `hotspotsMap`.
  </Card>

  <Card title="Clarity" icon="gauge" href="/concepts/predictions-model">
    A 0–100 score for how clear and easy to process a design is.
  </Card>

  <Card title="Excitingness" icon="bolt" href="/concepts/predictions-model">
    A 0–100 score for a design's visual and emotional impact.
  </Card>

  <Card title="Ad Visibility" icon="bullseye" href="/api-reference/create-ad-visibility">
    A score for how well a creative stands out and captures attention in context.
  </Card>
</CardGroup>

Prefer words to numbers? Generate an [AI summary](/api-reference/get-summary) and [recommendations](/api-reference/get-recommendations) for any analysis.

## How it works

<Steps>
  <Step title="Get your API key">
    API access isn't self-serve — contact [sales@eyequant.com](mailto:sales@eyequant.com) to request your bearer token.
  </Step>

  <Step title="Submit a design">
    POST an image, URL, or video to the API and choose which predictions you want.
  </Step>

  <Step title="Poll for results">
    Analyses run asynchronously — poll the returned URL until `status` is `success`.
  </Step>

  <Step title="Download your outputs">
    Retrieve the maps and scores, and store them — result links are time-limited.
  </Step>
</Steps>

<Note>
  EyeQuant API credentials are provisioned on request. Reach out to [sales@eyequant.com](mailto:sales@eyequant.com) to get started.
</Note>