API Overview

The Aeye REST API lets you trigger workflows, manage resources, and read results programmatically — from any language, any platform, any stack.

‍

Base URL

All API requests are made over HTTPS to the following base URL. There is no versioning in the path — breaking changes are announced with a deprecation window.

BASE: https://api.aeye.io/v1

‍

Authentication

Aeye uses API keys for authentication. Every request must include your key in theAuthorizationheader. Keys are scoped to a project and carry the permissions you define in your dashboard.

1. Bearer Token: Pass your key asBearer <key>in theAuthorizationheader. Recommended for all server-side calls.
2. Query Param: Append?api_key=<key>to the URL. Only for testing — never use in production or client-side code.