All API requests must include a valid API key in the Authorization header using the Bearer scheme:
Authorization: Bearer YOUR_API_KEY
Generating API keys
API keys are scoped to a workspace. To generate one:
- Open the Sweetr dashboard.
- Navigate to Settings > Workspace.
- Scroll down to the API section.
- Click Regenerate and copy the generated key.
API keys are only displayed once at creation time. Store them securely, for
example as a secret in your CI/CD provider.
Security best practices
- Never commit API keys to source control.
- Use CI/CD secrets (e.g., GitHub Actions secrets, GitLab CI variables) to inject keys at runtime.
