Skip to content

MngGetAIKnowledgeDocuments

GET ai/knowledge/documents

The documents the index holds. Text is not returned: documents live in the repository and are edited there, through review — this method shows what the service picked up.

Access Control

Allowed: admin. A super administrator sees every brand; an administrator sees the global documents and those of their own brand.

Parameters

Parameter Type Description
scope enum all (default), global or brand

Response Data

{
  "rows": [
    {
      "id": "trading.margin-call",
      "title": "Margin call and stop out",
      "section": "Trading",
      "language": "en",
      "audience": "internal",
      "scope": "global",
      "brand": "*",
      "keywords": ["margin call", "stop out"],
      "intents": ["What is a margin call?"],
      "routes": ["/trade"],
      "source": "global/trading/margin-call.md",
      "updatedAt": "2026-09-16",
      "chunks": 4,
      "chars": 2317
    }
  ],
  "count": 52
}

Two fields decide who can see a document. language — the answer prefers the variant matching the language of the question. audienceinternal documents never reach a client session, client ones are written for clients, all suits both. The same id appears once per language.

Errors

Code Error Description
403 AI_ACCESS_DENIED The session is not an administrator