Creating a Key
Go to Settings → API Keys → Create Key. You will need to configure:
- Name: a label to identify this key (e.g., "production", "staging", "personal project")
- Scopes: permissions the key grants:
read(fetch data),write(create/update),admin(delete, manage) - Expiration: choose 30 days, 90 days, 365 days, or never
Click Create and the key is displayed once. Copy it immediately and store it securely: you will not be able to view it again.
Authentication
Include your API key in the Authorization header of every request:
Authorization: Bearer rk_your_api_key_here
All API keys are prefixed with rk_ so they are easy to identify in your codebase.
Managing Keys
View all your active keys at Settings → API Keys. From there you can:
- Revoke a key: immediately invalidates it. Any requests using this key will return
401 - Create additional keys: use separate keys for different environments or services
- View usage: see request counts and last-used timestamps for each key
Security Best Practices
- Never commit API keys to version control: use environment variables
- Use the minimum required scopes: a read-only integration does not need
writeoradmin - Rotate keys periodically: set expiration dates and create new keys before old ones expire
- Revoke compromised keys immediately: there is no cooldown on revocation