Documentation
Home

API Reference

Interact with the backend modules directly via the REST API.

Authentication

Most API routes require an API key or an active user session.

bash
X-API-KEY: your-api-key

Endpoints

GET/api/module/chat

Send a message to the chat module and receive a streaming response.

Query Parameters:
  • message (string): The user message.
  • conversationId (string): ID of the conversation history.
GET/api/module/image

Generate an image from a text prompt.

Query Parameters:
  • prompt (string): Description of the image to generate.
POST/api/module/rag

Interact with the RAG (Retrieval-Augmented Generation) module.

Form Data:
  • action (string): "upload" or "query".
  • file (file): Document to upload (if action is upload).
  • question (string): Question to ask about the document (if action is query).