Skip to main content
The AeoNut API lets your scripts, dashboards and AI assistants read the data AeoNut already collects for your workspace. That includes your AI visibility, your competitors, the sources AI answers cite, your content map and your content library.
Every read is free, and nothing in the API spends credits today.

​
Base URL

All the paths in these docs are relative to this base URL, so /me means the base URL with /me on the end.

​
Quick start

1

Create an API key

Go to Settings → API keys and click Create key. Give it a name and pick an expiry. New keys get all five scopes by default, and you can remove the ones you don’t need.
2

Copy the key

We only show the key once, so copy it right away and keep it in an environment variable or a secrets manager.
3

Make your first request

You can call /me to check that the key works:
Only workspace owners can create and revoke keys. A key acts as the person who created it, so if that person leaves the workspace, the key stops working.

​
Authentication

Send your key with every request in either of these headers:
Each key belongs to one workspace, which is why you won’t see a workspace ID in any path. Every key starts with ds_live_, and in the examples on this page you’d put your whole key where it says YOUR_API_KEY. AeoNut only stores a hash of the key, so if you lose one we can’t get it back for you. In that case you can revoke it and create a new one. A revoked key stops working on the very next request.

​
Scopes

Each key has scopes, and they decide which endpoints the key can call. The API only reads data, so every scope is free to use. Each scope unlocks one path prefix. GET /me works with any key, whatever scopes it has.
It helps to give each integration its own key with only the scopes it needs. That way you can revoke one key without breaking the others.

​
Response format

Every response comes back in the same wrapper:
All rates are fractions between 0 and 1, so a mention rate of 0.42 means 42%.

​
Errors

The API uses the standard HTTP status codes. When you get a 403, the response tells you which scopes the key is missing:

​
Rate limits

You can make 120 requests per minute per workspace, and that limit is shared across all of the workspace’s keys. If you go over it, the API returns a 429. When that happens, wait a few seconds before you try again, and wait a little longer each time if it keeps happening.

​
Next steps

Connect an AI assistant

Use the AeoNut MCP server with Claude, Cursor or VS Code.