Organization and settings

All routes live under https://chat.realmoon.ai/api/v1/orgs/{org_id}. Scopes: org:read to read, org:write to write, except for the directory (see below).

Overview#Link to the Overview section

GET /overview · org:read

{
  "org": { "id": "8c1f2a4e-5b6d-4e7f-9a0b-1c2d3e4f5a6b", "name": "Lycée Victor-Hugo", "slug": "lycee-victor-hugo", "description": null, "logo_url": null, "org_kind": "education", "managed": true, "created_at": 1751328000 },
  "members": { "active": 380, "suspended": 4 },
  "invitations_pending": 25,
  "groups": 42,
  "usage_scope": "workspace",
  "activity": {
    "active_30d": 295, "requests_30d": 18422, "active_7d": 241, "requests_7d": 5100,
    "month_pct_avg": 37.4,
    "top": [{ "user_id": "41ab2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d", "name": "Léa Dupont", "month_pct": 98.2 }]
  },
  "alerts": []
}

“To do” list#Link to the “To do” list section

GET /alerts · org:read

Returns {"items": [...], "total": n}. Each item has code, severity (danger, warning or info), title, detail, href (a page of the admin console), count and params. An alert is only returned if the key holds one of the permissions it relates to.

For automated processing, rely on code and params: title and detail are written for the console.

Identity and settings#Link to the Identity and settings section

Read#Link to the Read section

GET /general · org:read

{
  "id": "8c1f2a4e-5b6d-4e7f-9a0b-1c2d3e4f5a6b",
  "name": "Lycée Victor-Hugo",
  "slug": "lycee-victor-hugo",
  "description": "Établissement public",
  "logo_url": null,
  "created_at": 1751328000,
  "owner": { "id": "a11f3c5e-7b9d-4f1a-8c2e-4d6f8a0b2c4e", "name": "Claire Moreau", "email": "claire.moreau@ecole.fr" },
  "is_personal": false,
  "org_kind": "education",
  "org_kinds": ["team", "education", "company", "public_sector", "other"],
  "managed": true,
  "outside_access": true,
  "retention_days": 365,
  "retention_applied": true,
  "policy_version": 88,
  "members_active": 380,
  "retained_accounts": 0,
  "has_active_contract": true,
  "memory_policy": "allowed",
  "can": { "memory": false, "edit": true, "policies": true, "transfer": false, "delete": false, "platform": false }
}

Update#Link to the Update section

PATCH /general · org:write

Only the fields you send are processed. managed, outside_access and retention_days also require the rules:read or rules:write scope. The response has the same shape as the read.

curl -X PATCH https://chat.realmoon.ai/api/v1/orgs/$ORG_ID/general \
  -H "Authorization: Bearer $MOONAI_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Lycée Victor-Hugo", "retention_days": 365}'

import os
import requests

r = requests.patch(
    f"https://chat.realmoon.ai/api/v1/orgs/{os.environ['ORG_ID']}/general",
    headers={"Authorization": f"Bearer {os.environ['MOONAI_ADMIN_KEY']}"},
    json={"name": "Lycée Victor-Hugo", "retention_days": 365},
    timeout=30,
)
r.raise_for_status()
print(r.json()["retention_days"])

const r = await fetch(`https://chat.realmoon.ai/api/v1/orgs/${process.env.ORG_ID}/general`, {
  method: 'PATCH',
  headers: { Authorization: `Bearer ${process.env.MOONAI_ADMIN_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({ name: 'Lycée Victor-Hugo', retention_days: 365 }),
});
if (!r.ok) throw new Error(await r.text());
console.log((await r.json()).retention_days);

In a managed organization with a retention period, chats inactive for longer than that period are deleted every night.

Retention preview#Link to the Retention preview section

GET /general/retention-preview?days=365 · org:read

Returns {"days": 365, "count": 1204, "applied": true}: the number of chats in the workspace that have not been changed for days days. days is required, from 30 to 3,650.

Settings only#Link to the Settings only section

GET /settings (org:read) and PATCH /settings (org:write) read and update org_kind, managed, outside_access and retention_days, with the same rules as /general, without the organization’s identity.

Member directory#Link to the Member directory section

The directory controls what a member can see of the other members.

GET /directory · members:read

{ "value": null, "default": "groups", "effective": "groups", "options": ["all", "groups", "admins"] }

value is null when the organization follows the default: groups for a managed or education organization, all otherwise.

PUT /directory · org:write

See also#Link to the See also section

• Rules
• Licenses and contract
• Usage and audit log