Getting started
Authentication
Most endpoints take an API key sent as a Bearer token. The two AI crawler endpoints are free and need no key.
The header
Send Authorization: Bearer dfa_live_…. A key is dfa_live_ followed by 43 characters (letters, digits, - and _). The scheme word is case-insensitive. A header that is missing or does not match that shape is refused with 401 unauthorized before any lookup.
Getting a key
Create keys in the console, signed in with your AEO Toolkit account. A key belongs to a workspace and draws on that workspace’s plan, the same as the dashboard. Only a hash of the key is stored, so it is shown once: copy it then. A workspace can hold up to 10 active keys. A key stops working when the member who created it leaves the workspace, and a revoked key answers 401.
Which endpoints need a key
| Endpoint | Key |
|---|---|
GET /ai-crawlers | None |
POST /ai-crawlers/verify | None |
GET /demand | Required |
GET /keywords | Required |
GET /referrals | Required |
GET /citations | Required |
POST /answers/live | Required |
GET /me | Required |
Browsers and CORS
The free endpoints answer with access-control-allow-origin: *, so a web page can call them directly. Keyed endpoints send no CORS headers, so a browser cannot call them. Call them from a server and keep the key in an environment variable, never in client code.