API Key
Get a keyAuthentication
All API requests require a valid API key. Keys are prefixed with bf_ and managed on the API keys page.
Passing your API key
Send your key in the X-API-Key header:
curl -H "X-API-Key: bf_your_key_here" \
https://api.beefi.ai/api/v1/companies/search?q=appleYou can also send it as a bearer token:Authorization: Bearer bf_your_key_here.
Note: Keys in the URL are rejected. A request with ?api_key= returns 401, because URLs end up in server logs and browser history.
Error responses
| Status | Meaning | Response |
|---|---|---|
| 401 | Missing API key | Missing API key. Send it in the X-API-Key header or as Authorization: Bearer <key>. |
| 401 | Invalid or expired key | Invalid or expired API key. |
| 429 | Rate limit exceeded | Rate limit exceeded: 100 requests per minute on the Free plan. |
| 429 | Monthly quota used | Monthly quota used: 10000 requests on the Free plan. Resets 2026-12-01 (UTC). |
Key security
- • Keys are hashed with SHA-256 and cannot be recovered. Store your key securely when created.
- • Never expose your key in client-side code or public repositories.
- • Revoke a leaked key right away on the API keys page.