API Reference
Authentication
API key authentication, scopes, and security best practices.
API Keys
Reaktly uses API key authentication for all programmatic access. Keys are created in the dashboard by users with Owner or Admin roles.
Creating an API Key
- Go to Settings → API Keys in the dashboard
- Click Create API Key
- Set a name, description, and scopes
- Copy the key — it's only shown once
Using API Keys
Include your key in the x-api-key header:
curl -H "x-api-key: rk_live_abc123..." https://api.reaktly.com/ingestScopes
API keys are scoped to limit access:
| Scope | Permission |
|---|---|
iq:import | Push data to the knowledge base via Ingestion API |
iq:read | Read knowledge base items |
usage:read | Read usage and analytics data |
articles:read | Read published articles |
Security Best Practices
- Store API keys in environment variables, never in code
- Use the minimum required scopes
- Set expiration dates on keys
- Rotate keys periodically
- Use separate keys for each integration