Get started
Authentication
Every request is scoped to a workspace and must be authenticated. There are two credential types.
API key (recommended for servers)
Create a key in Settings → API keys and send it in the X-API-Key header:
bash
curl https://api.orbicrawl.com/api/v1/leads \
-H "X-API-Key: oc_live_..."- Keys are shown once at creation — store them securely.
- Revoke a key any time from the dashboard; revocation is immediate.
- API keys are for data endpoints (jobs, leads, exports, AI). They are intentionally blocked from admin, billing and account-security actions — those require an interactive session.
Bearer token (dashboard / SPA)
The web app authenticates with a short-lived (15-minute) access token via Authorization: Bearer <token>, refreshed automatically through an HttpOnly cookie. You normally don't handle these directly — use an API key for scripts.
bash
curl https://api.orbicrawl.com/api/v1/leads \
-H "Authorization: Bearer <access_token>"Errors
Failures return a uniform envelope:
json
{ "error": { "code": "unauthorized", "message": "invalid API key" } }| Status | Meaning |
|---|---|
401 | Missing or invalid credentials |
403 | Authenticated but not allowed (e.g. API key on an admin route) |
402 | Out of credits — top up to continue |
422 | Request validation failed (see details) |
429 | Rate limited — slow down |
Warning
Never expose an API key in client-side code or a public repository. Use it from a server, an SDK, or the Chrome extension (which stores it locally).