API Reference
Authentication
How to authenticate requests to the Kerabie API.
API Keys
API keys are the primary way to authenticate with the Kerabie API. They're scoped per organisation and never expire unless you revoke them.
Create a key
- Go to Settings → API → New API Key
- Give it a name (e.g. "CRM integration")
- Copy the key; it's shown only once
Use it in requests
Authorization: Bearer ker_live_abc123...
X-Kerabie-Org: 42
Content-Type: application/jsonOr with the SDK:
const kerabie = new KerAbieClient({
apiKey: 'ker_live_abc123...',
orgId: 42,
});Key prefixes
| Prefix | Environment |
|---|---|
ker_live_ | Production |
ker_test_ | Test (sandbox data, no real conversations) |
Revoking keys
Go to Settings → API and click the trash icon next to any key. Revocation is immediate.
Keeping keys secure
- Store keys in environment variables, never in source code
- Use separate keys per integration so you can revoke one without affecting others
- Rotate keys periodically for sensitive integrations
Never commit API keys to version control. If a key is exposed, revoke it immediately and create a new one.