Last updated: December 23, 2025
Status: v0.0.14 Documentation Complete - Phase 1, 2, 3 & 4 Finished ✅
Use this file as your jump-off point when you are not sure where a topic lives.
- Getting Started (5 minutes) - Run everything with Docker Compose.
- Architecture Overview - Understand each service and its role.
- API Overview - Learn how authentication and routing works.
- First API Call - Test the LLM API end to end.
- Makefile Commands - 100+ targets and helper commands.
- Setup: quickstart.md
- API overview: api/
- Development workflow: guides/development.md
- Documentation quality status: ../DOCUMENTATION_QUALITY_REPORT.md
- Process: ../CONTRIBUTING.md
- Security: architecture/security.md
- Release notes: ../CHANGELOG.md
- Quick Start Guide - Installation, prerequisites, and walkthrough.
- System Architecture - High-level diagram and components.
- LLM API Quick Start - Sample curl call with auth flow.
- Development Guide - Local + hybrid workflows, Make targets.
- Configuration System - Precedence rules and env var mapping.
- Testing Guide - jan-cli api-test collections, coverage, and best practices.
- Development Guide - Full Docker, dev-full (hybrid), and native execution modes.
- Service Template - Generate a new Go microservice (scaffold docs live here).
- API Overview - Authentication, headers, and service map.
- Endpoint Matrix - Complete reference matrix of all API endpoints.
- API Guides - Patterns, rate limiting, performance, and versioning.
- LLM API - Chat, models, conversations, streaming.
- Response API - Tool orchestration workflows.
- Media API - Upload, jan_* IDs, presigned URLs.
- MCP Tools - JSON-RPC endpoints for tool providers.
- API Examples - Ready-made curl/SDK snippets across services.
- Deployment Guide - Docker profiles, Kubernetes, and CI/CD.
- Multi-vLLM Deployment - High-availability multi-instance setup.
- Kubernetes Setup - Helm installation and cluster guidance.
- Monitoring Guide - Grafana, Prometheus, Jaeger, OTEL.
- Authentication & Gateway - Kong + Keycloak integration.
- Runbooks - On-call playbooks and incident steps.
- MCP Admin Interface - Dynamic tool management without code changes.
- Troubleshooting - Common errors and recovery steps (links out to runbooks).
- Security Policy - Responsible disclosure and hardening checklist.
- User Settings & Personalization - Customize user experience with settings and preferences.
- Conversation Management - Create, organize, delete, and share conversations.
- Browser Compatibility - Model capabilities for web automation and scraping.
- MCP Admin Interface - Admin tool management and content filtering.
- MCP Custom Tool Development - Build, test, and deploy custom MCP tools.
- Webhooks & Event Integration - Setup webhooks, handle events, verify signatures securely.
- Monitoring & Troubleshooting Deep Dive - Health checks, distributed tracing, incident response.
- Error Codes & Status Reference - Complete HTTP status codes with handling patterns.
- Rate Limiting & Quotas - Token bucket algorithm, per-endpoint limits, quota management.
- LLM API Comprehensive Examples - Python, JavaScript, cURL for all endpoints.
- Response API Comprehensive Examples - Generation, analysis, and batch operations.
- Media API Comprehensive Examples - Upload, management, OCR, previews.
- MCP Tools Comprehensive Examples - Discovery, execution, and real-world scenarios.
- Python SDK Quick-Start - Complete guide with 30+ examples (streaming, pagination, async, webhooks, MCP tools).
- JavaScript SDK Quick-Start - Full TypeScript support with 30+ examples.
- Go SDK Quick-Start - Idiomatic Go patterns for concurrency and connection pooling.
- Advanced API Patterns - Streaming, pagination strategies, batch operations, file uploads, workflows.
- Unified OpenAPI Specification - Complete REST API specification (40+ endpoints).
- Performance & SLA Guide - Service Level Agreements, latency targets, scaling strategies, cost optimization.
- Security Architecture Deep Dive - Authentication, RBAC, encryption, threat models, incident response.
- Documentation Quality Report - Release-ready criteria and latest findings.
- Conventions - Code style, patterns, and workflow.
docs/quickstart.md- Installation, prerequisites, and troubleshooting.docs/api/- Service-specific references plus shared overview.docs/architecture/- System design, services, security, data flow, observability.docs/configuration/- Loader behavior, precedence, env var mapping, infra/docker/k8s examples.docs/guides/- Development, deployment, testing, CLI, IDE, troubleshooting pointers.docs/runbooks/- On-call runbooks, incident playbooks, rate-limit/monitoring actions.docs/conventions/- Standards, patterns, workflow, and reviews.docs/architecture/services.md- Service responsibilities, ports, and dependencies at a glance.
Need something inside /services? Each microservice has its own README.md with implementation details.
- OpenAI API Docs
- Model Context Protocol
- JSON-RPC 2.0 Spec
- Kong Gateway, Keycloak, PostgreSQL
- OpenTelemetry, Prometheus, Jaeger, Grafana
- Markdown files in
/docs: 80+ (updated December 23, 2025). - Primary services covered: LLM API, Response API, Media API, MCP Tools, Memory Tools, Realtime API.
- Last major documentation update: December 23, 2025 (Phase 1, 2, 3 & 4 Complete).
- Phase 3 additions: 10 files (3 advanced feature guides + 7 API example guides).
- Phase 4 additions: 8 files (3 SDK guides + 1 patterns guide + 1 OpenAPI spec + 3 operations guides).
- Total documentation generated: 18,250+ lines (Phase 3 + 4 combined).
- Total code examples: 150+ (Python, JavaScript, Go, TypeScript, cURL, YAML, SQL).
- Next planned review: Post-launch monitoring and community feedback integration.
- Add new docs in the closest logical folder (guide vs runbook vs architecture) and link them here.
- Keep a single quick-start at
quickstart.md; avoid parallel setup docs. - Link examples via
api/examples/README.mdand keep service scaffolding details underguides/services-template.md. - Remove deprecated links from this index when content moves.