X-API-Key header. There is nothing else to set up.
Keys and workspaces
A key belongs to a workspace, and the workspace holds the credits your calls use. You can make as many keys as you like, for example one per environment or per service, and revoke any of them from the dashboard without touching the others. Keys start withhf_. Anyone who has your key can spend your credits.
When a key is refused
A refused request does no work and costs nothing. The error says why, in the same shape as every other error. No key, or a wrong or revoked key answers401:
Missing X-API-Key header instead.
An expired key also answers 401, with the date it expired: This API key expired on Oct 1, 2026. Create a new key in the dashboard.
A key locked to IP addresses, called from somewhere else, answers 403 and names the address the call came from:
Rotating a key
- Create a new key in the dashboard.
- Deploy it wherever the old one is used.
- Revoke the old key. This takes effect at once.
Next: Credits
What each call costs, and why failed calls are free.