# EyeQuant

## Docs

- [Create an ad visibility analysis](https://developers.eyequant.com/api-reference/create-ad-visibility.md): Submit an ad image to score how visible it is.
- [Create an analysis](https://developers.eyequant.com/api-reference/create-analysis.md): Submit a web page URL or an uploaded image to start a visual attention analysis.
- [Create a video analysis](https://developers.eyequant.com/api-reference/create-video-analysis.md): Submit a video for per-frame visual saliency analysis.
- [Generate recommendations](https://developers.eyequant.com/api-reference/generate-recommendations.md): Trigger asynchronous generation of actionable design recommendations for an analysis.
- [Generate a summary](https://developers.eyequant.com/api-reference/generate-summary.md): Trigger asynchronous generation of a written summary for an analysis.
- [Get an ad visibility analysis](https://developers.eyequant.com/api-reference/get-ad-visibility.md): Retrieve the status and ad visibility score of a submitted ad analysis.
- [Get an analysis](https://developers.eyequant.com/api-reference/get-analysis.md): Retrieve the status and outputs of a previously submitted analysis.
- [Get recommendations](https://developers.eyequant.com/api-reference/get-recommendations.md): Retrieve generated recommendations, or their current generation status.
- [Get a summary](https://developers.eyequant.com/api-reference/get-summary.md): Retrieve a generated summary, or its current generation status.
- [Get a video analysis](https://developers.eyequant.com/api-reference/get-video-analysis.md): Retrieve the status and outputs of a video analysis.
- [API Reference](https://developers.eyequant.com/api-reference/overview.md): A REST API for generating visual attention heatmaps, clarity scores, and excitingness scores for images, web pages, and video.
- [Check API status](https://developers.eyequant.com/api-reference/status.md): Verify your credentials and confirm the EyeQuant API is operational.
- [Search tags](https://developers.eyequant.com/api-reference/tag-search.md): Search the tags available for a given resource type.
- [Get tag summary](https://developers.eyequant.com/api-reference/tag-summary.md): Get a summary of the tags used across your account.
- [Update analysis metadata](https://developers.eyequant.com/api-reference/update-analysis-meta.md): Add context such as description, goal, audience, or brand guidelines to an existing analysis.
- [EyeQuant API Authentication: Bearer Tokens and HTTPS](https://developers.eyequant.com/authentication.md): EyeQuant uses Bearer token authentication over HTTPS. Learn how to attach your API key to every request and handle off-domain resource links.
- [Image Format Requirements, Dimensions, and Size Limits](https://developers.eyequant.com/concepts/input-formats.md): EyeQuant accepts PNG and JPEG images up to 5 MB, between 40px and 2000px on any side. PNG is strongly recommended for best results.
- [EyeQuant Input Model: Types, Media, and Parameters](https://developers.eyequant.com/concepts/input-model.md): Understand EyeQuant's input object — how to specify the type, content, medium, and optional parameters when requesting an analysis.
- [Predictions Model: Attention, Clarity, and Excitingness](https://developers.eyequant.com/concepts/predictions-model.md): EyeQuant supports three prediction types — attention, clarity, and excitingness. Learn what each predicts and what outputs are available.
- [Result Expiry: How to Store Your EyeQuant Analysis Outputs](https://developers.eyequant.com/concepts/result-expiry.md): EyeQuant analysis results and output maps are stored for a limited time. Download and store all heatmaps and scores on your own infrastructure.
- [Upload a PNG or JPEG Image for Visual Attention Analysis](https://developers.eyequant.com/guides/analyzing-images.md): Upload any PNG or JPEG image to EyeQuant as a Base64-encoded string to get full control over exactly which design or asset is analyzed.
- [Submit a Web Page URL for Visual Attention Analysis](https://developers.eyequant.com/guides/analyzing-urls.md): Submit any public web page URL to EyeQuant and receive a visual attention heatmap — desktop or mobile browser simulation supported.
- [Submit a WebM Video File for Per-Frame Attention Analysis](https://developers.eyequant.com/guides/analyzing-videos.md): Upload a .webm video to EyeQuant using a presigned storage URL and poll for per-frame visual attention analysis results across every frame.
- [Generated summaries and recommendations](https://developers.eyequant.com/guides/generated-summaries-and-recommendations.md): Generate natural-language summaries and actionable recommendations for an analysis, and learn which analysis id to use.
- [Run Multiple Prediction Types in a Single EyeQuant Call](https://developers.eyequant.com/guides/multiple-predictions.md): Request attention, clarity, and excitingness predictions together in one EyeQuant API call and retrieve all outputs in a single response.
- [EyeQuant: Predictive Visual Attention for Any Design](https://developers.eyequant.com/introduction.md): EyeQuant is a machine perception API that generates attention heatmaps, clarity scores, and excitingness scores for images and web pages.
- [Quickstart: Analyze Your First Design with EyeQuant](https://developers.eyequant.com/quickstart.md): Make your first EyeQuant API call — submit a web page URL, poll for the completed analysis, and download the visual attention heatmap in a few steps.
- [EyeQuant API Status, Availability, and Retry Guidance](https://developers.eyequant.com/reference/api-status.md): Learn how to check EyeQuant API availability, understand the over_capacity error, and handle service disruptions gracefully in your integration.
- [EyeQuant API Error Codes and HTTP Status Reference](https://developers.eyequant.com/reference/errors.md): EyeQuant returns structured JSON error responses with error codes. Reference all error codes, HTTP status meanings, and how to resolve each error.