Authentication

All Claradb API requests require authentication via a Bearer token.

Creating an API key

  1. Sign in to your workspace.
  2. Navigate to Settings > API Keys.
  3. Click Create Key and give it a descriptive name.
  4. Copy the key immediately — it won't be shown again.

Using your key

Include the key in the Authorization header of every request:

Terminal
curl -H "Authorization: Bearer cdb_live_YOUR_KEY" \
  https://claradb.com/api/v1/companies

Key prefixes

PrefixEnvironment
cdb_live_Production
cdb_test_Development/testing

Test keys return the same data but don't count against your production rate limits.

Security best practices

  • Never commit API keys to version control.
  • Use environment variables to store keys in your application.
  • Rotate keys periodically from the workspace settings.
  • Use test keys during development.
Authentication — Claradb Docs | Claradb