Skip to content
AlumiaDocs

Search docs

Find pages, headings, and concepts. Press ⌘K or Ctrl+K to toggle.

Docs assistant

Ask questions about Alumia documentation with cited answers from the in-app drawer.

Open in ChatGPTOpen in Claude

Every /docs page includes a floating Ask docs launcher. It opens a drawer that streams answers from POST /api/v1/docs/ask using retrieval over the same MDX corpus you are reading.

How to open it

  • Click Ask docs in the bottom-right corner of any documentation page.
  • Or press ⌘I / Ctrl+I (toggle). Escape closes the drawer.
  • Other UI can dispatch docs-ask:open on window to open it programmatically.

What it does

  1. Your question is sent to /api/v1/docs/ask with the AI SDK UI message transport.
  2. The server retrieves relevant doc chunks (lib/docs/retrieve) and builds a citation-first system prompt.
  3. The model answers with markdown links to source pages, for example [Agents](/docs/concepts/agents).
  4. Guardrails and public-abuse checks run on input and output; blocked responses fail closed.

The assistant does not use your project chat sessions, canvas, or org API keys. It is a public docs surface with its own rate limit (10 requests/minute/IP in production).

Suggested questions

Starter chips in the drawer cover common topics: peer messaging, API keys, supported models, and billing. Prefer specific questions ("How do I revoke a share link?") over vague ones ("Tell me about Alumia").

API (advanced)

POST /api/v1/docs/ask accepts either { question: string } or { messages: UIMessage[] } and returns a streamed UI message response. Rate limit: 10 requests/minute/IP in production.

When answers are wrong

If the drawer says it cannot find an answer, the topic may be undocumented or only described in internal operator docs. Check Troubleshooting for runtime errors, or file feedback from the dashboard.