Documentation
API reference.
REST API for reading sites, scans, citation queries, and triggering ad-hoc scans. Available on the Pro plan. JSON everywhere, Bearer auth, predictable error envelopes.
Quickstart
- 01
Mint an API key
Open /dashboard/api-keys, click New key, and copy the plaintext immediately — it’s shown only once.
- 02
Make a request
curl https://ae-optimiser-web.vercel.app/api/v1/sites \ -H "Authorization: Bearer aeo_live_..." - 03
Generate a typed client
The OpenAPI spec at
/api/v1/openapi.jsonis consumable byopenapi-typescript,openapi-generator, and any other code-gen tool that speaks OAS 3.1.
Endpoints
- GET
/sitesList sites
List all sites on your account.
- GET
/sites/{id}Fetch a single site
- id (path)required
- GET
/scansList scans
- site_id (query)· Filter to one site
- limit (query)
- POST
/scansTrigger a new scan
Trigger a scan synchronously. Returns the completed scan or an error. Rate-limited to 30 scans/hour per account.
- GET
/scans/{id}Fetch a single scan with check breakdown
- id (path)required
- GET
/citationsList tracked citation queries
- site_id (query)
Authentication & errors
Bearer auth
Every request must include an Authorization header with a key minted on the Pro plan. Format: aeo_live_xxxxx for production, aeo_test_xxxxx for staging.
Error envelope
Every error response is { error: { code, message } }. Branch on code, not message — messages may be improved over time.
Ready to integrate?
Mint a key on the Pro plan and wire AISEOLab into your stack today.