Book a Demo

HTTP API Documentation

Integrate attention prediction directly into your applications with our RESTful API

✓ RESTful Design ✓ JSON Responses ✓ Real-time Processing

API Overview

Access the RealEye Attention Predictor programmatically via HTTP API for seamless integration into web applications, automated workflows, and custom tools.

Endpoint

https://api.realeye.io/v1/predict_attention

Example endpoint - actual URL provided with API access

Authentication

Authorization: Bearer YOUR_API_KEY

Secure API key authentication required for all requests

Request Format

Send image data via HTTP POST request. Supported formats include JPEG, PNG, and WebP.

JSON Input Example

{
  "image_base64": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAAAAAAAD/2wBDAAYEBQYFBAY..."
}

cURL Example

curl -X POST \
  https://api.realeye.io/v1/predict_attention \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: image/jpeg" \
  --data-binary "@path/to/your_image.jpg"

Response Format

The API returns comprehensive attention prediction data in JSON format, including matrices for VAI, Hold, Speed, and Reach components across different time ranges.

JSON Response Structure

{
  "image_id": "user_provided_or_generated_id",
  "dimensions": {
    "width": 512,
    "height": 512
  },
  "attention_matrices": {
    "hold_500ms": [[0.1, 0.2, ...], [0.3, 0.4, ...], ...],
    "speed_500ms": [[...],[...], ...],
    "reach_500ms": [[...],[...], ...],
    "vai_500ms": [[...],[...], ...], // Calculated from hold+speed+reach
    "hold_1000ms": [[...],[...], ...],
    // ... additional time ranges
  }
}

Matrix Data

2D arrays representing Cell Attention Scores, normalized between 0.0 and 1.0 for easy visualization and analysis.

Multiple Metrics

Hold, Speed, and Reach predictions across different time intervals (500ms, 1000ms, 3000ms, etc.), with VAI calculated as a composite.

Flexible Output

Generate heatmaps, calculate AOI statistics, or integrate with analytics tools using the numerical data.

Ready to Start Building?

Get your API credentials and start integrating attention prediction into your applications today

Request API Access View Python SDK

Always refer to the official API documentation for the most current endpoints, authentication, and rate limits.