Integration & E2E Overview
This section starts from "How to integrate MimirQ into your environment" and complements the Frontend / Backend / Ops documentation: those cover pages and implementation details, while this section focuses on business outcomes, recommended paths, and contract entry points.
Integration Architecture Overview
Typical Integration Sequence
Three Narrative Layers (Pick the One You Need)
Business Layer: What outcome do I want?
- Pick your entry point by role (who is reading, where to start): Tenant & System Admin | Integration Engineer | SRE / Ops
- Follow a task playbook (single-page depth, verifiable): New Tenant Go-Live | Knowledge Base Ready for Q&A | Document Stuck in Parsing or Indexing
Operations Layer: How exactly do I call it, and in what order?
- Business scenario playbooks (end-to-end, with curl examples): Upload & Chat | Dataset RAG | Precheck Block | Retrieval Debug | More scenarios ...
- Integration pattern quick reference (common mechanisms): Auth Modes | Pagination | Multipart Upload | SSE Streaming | Error Codes | Idempotency & Retries
Contract Layer: Are fields, permissions, and coverage consistent?
- Human & machine-readable contracts: API_CONTRACT | FE/BE Debugging
- Full Schema / try calls: OpenAPI / Redoc
- Frontend route - Backend path matrix: FE/BE Matrix (generated)
Endpoint Quick Reference
| Domain | Key Endpoints | E2E Docs |
|---|---|---|
| Datasets | POST /datasets, GET /datasets/{id}, DELETE /datasets/{id} | E2E |
| Documents | POST /documents/upload, GET /documents/{id}/status | E2E |
| Chat | POST /chat/completions (SSE) | Scenario S01 |
| Retrieval | POST /retrieval/search | Scenario S04 |
| KG | POST /kg/trigger, GET /kg/{id}/graph | Scenario S05 |
| Evaluations | POST /evaluations/jobs | Scenario S07 |
| Governance | POST /governance/quarantine | Scenario S09 |
Authentication Flow Overview
Authentication Methods
MimirQ supports three authentication methods, in order of priority:
- JWT Bearer Token --
Authorization: Bearer <token>, suitable for frontend and OAuth integrations - API Key --
X-API-Key: <key>, suitable for service-to-service calls and automation scripts - Tenant Header --
X-Tenant-ID: <tenant>, multi-tenant isolation identifier (must be used in combination with one of the above auth methods)
See Auth Modes | Tenant Headers for details.
Relationship with Repository docs/integration/
Articles on this site focus on navigation and synthesis; in-depth long-form documents and checklists remain authoritative at docs/integration/*.md on GitHub (the table above links to commonly used ones).
Related Links
| Type | Link |
|---|---|
| Redoc | skygazer42.github.io/MimirQ |
| Scenario-based API Sequences | workflows.md |
| Contracts & Debugging | API_CONTRACT |
| Backend Handbook | Backend Overview |
| Frontend Handbook | Frontend Overview |
| Operations Handbook | Operations Overview |