An API key lets your scripts, tools or Claude read your Corvidae reports without a person signing in each time.
Before you start
-
You need a Corvidae login with administrator access. The API Key page is only shown to administrators.
-
A key works for the company it is created for, and only for the reports marked "API key" in the Reporting API Reference. It cannot change anything.
Create a key
-
Sign in to Corvidae and choose the company you want the key for.
-
Open Settings, then API Key (the key icon in the menu).
-
Select + New API Key.
-
Enter a name for the key, for example the tool or team that will use it. The name must be different from your other active keys for that company.
-
Choose when it expires. The default is 6 months. You can pick 3, 6 or 12 months.
-
Create the key, then copy it straight away.
The full key is shown only once. If you leave the page or switch company, it can't be shown again. Corvidae only keeps a masked version (for example abc****************). If you lose a key, revoke it and create a new one.
Use the key
Send it in the X-API-Key header:
curl "https://api.corvidae.ai/reporting/api/v2/traffic?companyId=123&startDate=2026-10-01&endDate=2026-10-31" \
-H "X-API-Key: <your key>"
To use it with Claude Code, see Connect Claude to Corvidae.
Limits and expiry
-
Two active keys per company. This lets you rotate without downtime: create the new key, switch your tools over, then revoke the old one.
-
Keys expire. Expired keys are flagged with a warning icon on the API Key page and stop working. Create a replacement before the date passes.
-
Revoked keys stay in the list greyed out, as a record. They don't count towards the two-key limit.
Revoke a key
On the API Key page, delete the key you want to stop. It stops working straight away. Do this at once if a key may have been shared or exposed.
Keep keys safe
-
Treat a key like a password. Don't put it in emails, chats, tickets, shared documents or source control.
-
Give each tool its own key, so you can revoke one without affecting the others.
-
Rotate keys before they expire.
Troubleshooting
|
What you see |
What to do |
|---|---|
|
The API Key page isn't in Settings |
Your login is not an administrator. Ask an administrator in your organisation, or your Corvidae contact. |
|
"+ New API Key" is greyed out |
The company already has two active keys. Revoke one you no longer need. |
|
|
The key is wrong, expired or revoked. Create a new one. |
|
|
The key is for a different company, or the report doesn't accept API keys. |