Organization

Organization

Your workspace's plan, quotas and settings, and the cross-model overview behind the dashboard home page.

Your workspace: its name, plan, settings and quotas, plus a cross-model overview that powers the dashboard's home page. API keys and users belong to one organization; every record is scoped to it.

#Retrieve the organization

GET/v1/organizationAPI key or session

The organization the token acts for, with its plan limits and this month's usage under quotas.

Returns

An Organization: id, name, slug, plan, settings, quotas {plan, limits, usage}, created_at.
org = client.organization.retrieve()
print(org.plan, org.quotas["usage"]["explanations_per_month"], "/", org.quotas["limits"]["explanations_per_month"])
curl https://api.kaimei.ai/v1/organization \
  -H "Authorization: Bearer $KAIMEI_API_KEY"
200 OKResponse
{
  "object": "organization",
  "id": "org_c72a301b93331f42b7b9",
  "name": "Kaimei Demo",
  "slug": "kaimei-demo",
  "plan": "free",
  "settings": {},
  "quotas": {
    "plan": "free",
    "limits": {
      "models": 10,
      "api_keys": 5,
      "predictions_per_month": 5000,
      "explanations_per_month": 500,
      "analyses_per_month": 20
    },
    "usage": {
      "models": 4,
      "api_keys": 2,
      "predictions_per_month": 1560,
      "explanations_per_month": 27,
      "analyses_per_month": 6
    }
  },
  "created_at": "2026-10-31T22:37:25.334655Z"
}

#Update the organization

PATCH/v1/organizationAdmin session only

Rename the organization or change its settings. Owners and admins only, from a dashboard session. settings.quotas may lower any plan limit (models, api_keys, predictions_per_month, explanations_per_month, analyses_per_month) but never raise one; 403 quota_override_not_allowed otherwise.

Body parameters

namestringoptional

settingsobjectoptional

Merged into the existing settings. quotas is validated as described.

Returns

The Organization.
client.auth.login(email="[email protected]", password="...")
client.organization.update(settings={"quotas": {"explanations_per_month": 300}})
curl -X PATCH https://api.kaimei.ai/v1/organization \
  -H "Authorization: Bearer $SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"settings": {"quotas": {"explanations_per_month": 300}}}'
200 OKResponse
{
  "object": "organization",
  "id": "org_c72a301b93331f42b7b9",
  "name": "Kaimei Demo",
  "slug": "kaimei-demo",
  "plan": "free",
  "settings": {
    "quotas": {"explanations_per_month": 300}
  },
  "quotas": null,
  "created_at": "2026-10-31T22:37:25.334655Z"
}

#Workspace overview

GET/v1/organization/overviewAPI key or session

The dashboard home page in one call: counts across the workspace, a daily series for the last 31 days, the 12 most recently updated models, the 8 most recent explanations and the 6 most recent medium or high insights as alerts.

Returns

{organization, counts, series, models, recent_explanations, alerts}.
overview = client.organization.overview()
print(overview.counts)
for alert in overview.alerts:
    print(alert["severity"], alert["type"], alert["summary"])
curl https://api.kaimei.ai/v1/organization/overview \
  -H "Authorization: Bearer $KAIMEI_API_KEY"
200 OKResponse
{
  "organization": {
    "object": "organization",
    "id": "org_c72a301b93331f42b7b9",
    "name": "Kaimei Demo",
    "slug": "kaimei-demo",
    "plan": "free",
    "settings": {},
    "quotas": null,
    "created_at": "2026-10-31T22:37:25.334655Z"
  },
  "counts": {
    "models": 5,
    "active_models": 5,
    "predictions_30d": 860,
    "explanations_30d": 60,
    "predictions_total": 860,
    "explanations_total": 60,
    "analyses_total": 5,
    "analyses_running": 0,
    "insights_total": 31
  },
  "series": [
    {"date": "2026-10-01", "predictions": 0, "explanations": 0},
    …,
    {
      "date": "2026-10-31",
      "predictions": 212,
      "explanations": 24
    }
  ],
  "models": [
    {
      "object": "model",
      "id": "mdl_8f795e8afd954a787785",
      "slug": "cats-dogs-v1",
      …: …
    },
    …
  ],
  "recent_explanations": [
    {
      "object": "explanation",
      "id": "exp_7d7add16c796eafac087",
      …: …
    },
    …
  ],
  "alerts": [
    {
      "object": "insight",
      "id": "ins_a0a2b5c4a5ddb552758a",
      "type": "drift",
      "severity": "medium",
      …: …
    },
    …
  ]
}