Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kaireonai.com/llms.txt

Use this file to discover all available pages before exploring further.

Tenant management endpoints for checking workspace status and resetting playground environments.

​
GET /api/v1/tenant/status

Check tenant status including playground status and quota usage. No authentication required beyond tenant context.

​
Response (playground tenant)

{
  "isPlayground": true,
  "isDemoMode": false,
  "hasData": true,
  "quotaUsed": 1250,
  "quotaLimit": 5000,
  "quotaExceeded": false
}

​
Response (non-playground tenant)

{
  "isPlayground": false,
  "isDemoMode": false
}
Non-playground tenants only receive isPlayground and isDemoMode. The quota and data fields are omitted.
FieldDescription
isPlaygroundWhether the tenant is a playground workspace
isDemoModeWhether the server is running in demo mode (DEMO_MODE=true)
hasDataWhether the tenant has any categories configured (playground only)
quotaUsedNumber of decisions used (playground only)
quotaLimitLifetime decision cap (playground only)
quotaExceededWhether the quota has been exceeded (playground only)

​
POST /api/v1/tenant/reset

Reset a playground workspace, deleting all tenant data. Only available for playground tenants. Admin only.
This permanently deletes all data in the tenant. This action cannot be undone.

​
Request Body

FieldTypeRequiredDescription
confirmbooleanYesMust be true to proceed

​
Example

curl -X POST https://playground.kaireonai.com/api/v1/tenant/reset \
  -H "Content-Type: application/json" \
  -H "X-Tenant-Id: my-tenant" \
  -H "X-User-Role: admin" \
  -d '{ "confirm": true }'

​
Response

{ "message": "Workspace reset successfully. Decision counter is back to 0." }

​
Error — Non-Playground Tenant

{ "error": "Tenant reset is only available for playground workspaces" }

​
Error — Missing Confirmation

{ "error": "Confirmation required. Send { confirm: true } to proceed." }