Using the AEOify API
Access AEOify programmatically to create reports, fetch results, and integrate with your workflows.
What can the AEOify API do?
The AEOify API lets you create reports, fetch results, and manage your account programmatically. All requests require authentication with an API key.
Authentication
Include your API key as a Bearer token in the Authorization header:
Authorization: Bearer aeo_your_key_here
See API keys for instructions on creating a key.
Core endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/reports | Create a new report |
| GET | /api/reports?shareToken=X | Get a report by share token |
| GET | /api/reports/[id] | Get a report by ID |
| GET | /api/usage | Check your scan usage |
Creating a report
Send a POST request to /api/reports with the URL you want to analyze:
POST /api/reports
Content-Type: application/json
Authorization: Bearer aeo_your_key_here
{ "url": "https://example.com" }
The response includes the report ID. The analysis runs in the background. Poll the report endpoint to check when it is complete.
Fetching a report
Use the report ID from the creation response:
GET /api/reports/[id]
Authorization: Bearer aeo_your_key_here
Checking usage
Check how many scans you have remaining:
GET /api/usage
Authorization: Bearer aeo_your_key_here
Rate limits
API requests are subject to rate limiting. If you receive a 429 response, wait before retrying.
MCP alternative
For a higher-level integration, consider the MCP integration which provides structured tool access to all AEOify features.
- Is the API included in all plans?
- Yes. API access is available on all AEOify plans. You need to create an API key from your dashboard to get started.
- Do API scans count against my limit?
- Yes. Creating a report via the API uses one scan from your allocation, the same as creating one from the dashboard.