Browse the docs
Documentation
From an empty directory to a working, policy-guarded, multi-provider inference call — then everything deeper: routing, caching, tools, analytics, deployment, and the full API reference.
Start here
Get started
- Getting startedEmpty directory to a working inference call in five minutes./docs/getting-started
- InstallationChoose a deployment path: Docker, native, desktop, or tunnel./docs/installation
- DockerRun the full stack with one command via Docker Compose./docs/installation/docker
- Native installRun Synapass directly on a Linux or Windows host./docs/installation/native
- Desktop appInstall the Windows desktop app with its bundled backend./docs/installation/desktop
- Cloudflare tunnelExpose a local stack temporarily for demos and phones./docs/installation/cloudflare-tunnel
- ConfigurationOne config model: file, environment variables, and precedence./docs/configuration
- DeploymentTake Synapass to staging and production with confidence./docs/deployment
Core concepts
- OverviewWhat Synapass is, the problem it solves, and what it delivers./docs/overview
- ArchitectureThe request path, the deployment topology, and why each store exists./docs/architecture
- ProvidersRegister OpenAI, Anthropic, Ollama, vLLM, and any OpenAI-compatible API./docs/providers
- ModelsThe model registry: capabilities, pricing, aliases, and sync./docs/models
- RoutingStrategies, fallback chains, and cost-aware model selection./docs/routing
- PoliciesMatch requests on tenant, task, size, and sensitivity — then enforce./docs/policies
- CachingExact, prefix, and semantic tiers with tenant isolation./docs/caching
- ToolsTool registry, execution modes, and bounded agent runs./docs/tools
- EndpointsNamed routing scopes with copy-paste client examples./docs/endpoints
Operate
- PlaygroundTry models and endpoints from the dashboard before writing code./docs/playground
- AnalyticsThroughput, latency percentiles, spend, and quality over time./docs/analytics
- DashboardEvery console page, workflow, and the first-run admin setup./docs/dashboard
- ObservabilityPrometheus metrics, OTLP traces, JSON logs, and Grafana alerts./docs/observability
- DatabaseTables, migrations, and persistence boundaries./docs/database
Reference
- API referenceEvery endpoint, header, auth flow, and error code./docs/api
- TroubleshootingSymptoms, causes, and the checks that resolve them./docs/troubleshooting
- FAQShort practical answers to the questions everyone asks./docs/faq
- SecurityAuth, isolation, secrets, audit logging, and safe production config./docs/security
- GlossaryWhat each Synapass term means — precisely./docs/glossary
- ChangelogWhat each delivery phase added, and what changed./docs/changelog