Authentication
All API requests require a valid API key. Keys are prefixed with bf_ and managed from your dashboard.
Passing your API key
You can authenticate using either method:
Header (recommended)
curl -H "X-API-Key: bf_your_key_here" \
https://api.beefi.ai/api/v1/companies/search?q=appleQuery parameter
https://api.beefi.ai/api/v1/companies/search?q=apple&api_key=bf_your_key_hereNote: Using the header method is recommended. Query parameters may be logged in server access logs and browser history.
Error responses
| Status | Meaning | Response |
|---|---|---|
| 401 | Missing API key | Missing API key. Provide X-API-Key header or api_key query param. |
| 401 | Invalid or expired key | Invalid or expired API key. |
| 429 | Rate limit exceeded | Rate limit exceeded. Upgrade your plan for higher limits. |
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 compromised keys immediately from your dashboard.