Skip to main content
The Klara API uses API keys for authentication. Each key is scoped to your organization and can be managed from your dashboard.
Sandbox vs Production: API keys are environment-specific. Generate sandbox keys from sandbox.klara-ai.com and production keys from app.klara-ai.com. Keys from one environment do not work in the other.

API key format

API keys consist of two parts separated by a period:
klara_{client_id}.{secret}
ComponentDescription
klara_Fixed prefix identifying Klara API keys
client_id24-character hex identifier
secret32-character base64url-encoded secret

Using your API key

Include your API key in the Authorization header of every request:
Authorization: Bearer klara_abc123def456789012345678.ABCDEFghijklmnop1234567890QRSTUV
Never expose your API key in client-side code, public repositories, or logs.

Managing API keys

Creating a key

  1. Go to Settings → Integrations → API Keys in your Klara dashboard
  2. Click Create API Key
  3. Enter a descriptive name
  4. Copy the full key immediately—the secret is only shown once

Revoking a key

  1. Go to Settings → Integrations → API Keys
  2. Find the key you want to revoke
  3. Click Revoke and confirm
Revoked keys stop working immediately.

Scopes

API keys are created with scopes that determine what actions they can perform:
ScopeDescription
rfi:createCreate new RFI requests
rfi:readRead RFI request status

Error responses

Authentication failures return a 401 Unauthorized response:
{
  "error": "unauthorized",
  "message": "Invalid or expired API key"
}