Skip to main content
Every request to the Kalent API must include your workspace API key. You can pass it in one of two ways:

​
Get your API key

  1. Log in to the Kalent dashboard.
  2. Navigate to your workspace settings.
  3. Open the API Keys section.
  4. Click Create API Key and copy the generated secret.
Store your API key securely. Do not commit it to version control or expose it in client-side code.

​
Error responses

All REST API errors use the same envelope: 
{
  "success": false,
  "error": {
    "code": "error_code",
    "message": "Human-readable message",
    "debugTrackingCode": "..."
  }
}
Statuserror.codeMeaning
401missing_api_keyNo key was provided in the request.
401invalid_api_keyThe key does not match any active workspace key, or the OAuth access token is invalid or expired.
402plan_upgrade_requiredThe workspace must subscribe to Kalent or upgrade its plan before using this API capability.
429rate_limit_exceededIP-level or API-key-level rate limit exceeded.
Subscription and plan errors include an actionable details object: 
{
  "success": false,
  "error": {
    "code": "plan_upgrade_required",
    "message": "A Kalent subscription or plan upgrade is required to create sourcings. Please subscribe or upgrade your plan in Kalent billing: https://app.kalent.ai/settings/billing",
    "debugTrackingCode": "...",
    "details": {
      "code": "subscription_or_plan_upgrade_required",
      "action": "subscribe_or_upgrade",
      "capability": "create_sourcings",
      "billingUrl": "https://app.kalent.ai/settings/billing"
    }
  }
}