Organisation et réglages

Toutes les routes sont sous https://chat.realmoon.ai/api/v1/orgs/{org_id}. Portées : org:read pour lire, org:write pour écrire, sauf pour l’annuaire (voir plus bas).

Vue d’ensemble#Lien vers la section Vue d’ensemble

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": []
}

Liste « À faire »#Lien vers la section Liste « À faire »

GET /alerts · org:read

Rend {"items": [...], "total": n}. Chaque élément : code, severity (danger, warning ou info), title, detail, href (page de l’administration), count, params. Une alerte n’est rendue que si la clé détient une des permissions qui la concernent.

Pour un traitement automatique, appuyez-vous sur code et params : title et detail sont écrits pour la console.

Identité et réglages#Lien vers la section Identité et réglages

Lire#Lien vers la section Lire

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 }
}

Modifier#Lien vers la section Modifier

PATCH /general · org:write

Seuls les champs envoyés sont traités. managed, outside_access et retention_days demandent en plus la portée rules:read ou rules:write. La réponse a la forme de la lecture.

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);

Avec une organisation gérée et une durée de conservation, la suppression des conversations inactives depuis plus longtemps a lieu chaque nuit.

Aperçu de la conservation#Lien vers la section Aperçu de la conservation

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

Rend {"days": 365, "count": 1204, "applied": true} : le nombre de conversations du workspace qui n’ont pas été modifiées depuis days jours. days est obligatoire, de 30 à 3 650.

Réglages seuls#Lien vers la section Réglages seuls

GET /settings (org:read) et PATCH /settings (org:write) lisent et modifient org_kind, managed, outside_access et retention_days, avec les mêmes règles que /general, sans l’identité de l’organisation.

Annuaire des membres#Lien vers la section Annuaire des membres

L’annuaire règle ce qu’un membre voit des autres membres.

GET /directory · members:read

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

value vaut null quand l’organisation suit le défaut : groups pour une organisation gérée ou d’enseignement, all sinon.

PUT /directory · org:write

Voir aussi#Lien vers la section Voir aussi

• Règles
• Licences et contrat
• Utilisation et journal