# OpenSmartRoute > OpenSmartRoute is an open-source router that sits between your team, your apps and the AI models they use. For every request it picks the most cost-effective model, agent or tool that meets your quality rules, keeps personal data and secrets out of the prompt before it is sent, and shows why it chose what it did. Upload last month's bill and see what you would have saved. OpenSmartRoute is an open-source Python router that picks the best LLM, agent, skill, tool or human for every request on cost, quality, latency and policy, with a per-request trace and a hosted API at https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io. Install with `pip install opensmartroute` or `osr` from the install scripts on the landing page. Every documentation page below is also served as Markdown (add `.md` to its URL); https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/llms-full.txt is the whole documentation in one file. ## Start here - [Home](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io): product overview, install one-liners and the hosted platform. - [Model catalogue](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/models): routing targets and the reference LLM catalogue with list prices. - [Providers](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/providers): the OpenAI-compatible providers this deployment executes on, with prices and health. - [Vendors](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/vendors): every LLM vendor with models, prices and releases. - [Pricing](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/pricing): Free, Pro, Team and Enterprise plans for the hosted API. - [Compare](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/compare): OpenRouter, LiteLLM, Portkey and in-house routers side by side. - [REST API reference](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/api): every endpoint with parameters and examples. - [OpenAPI document](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/openapi.json): the complete OpenAPI 3.1 description of the platform API (https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/api/v1). ## Get started What OpenSmartRoute is and the fastest path to a first routed request - hosted or in your own code. - [What is OpenSmartRoute](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/readme.md): The open-source AI model router: what it routes, how it decides, what it costs to run and where to start. - [Platform quickstart](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/QUICKSTART_PLATFORM.md): Five minutes to a first routed request: workspace, API key, POST /api/v1/route, the OpenAI-compatible endpoint, feedback. - [Python SDK quickstart](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/QUICKSTART_SDK.md): Five minutes to routing in your own process: install, describe targets, route, constrain, learn from outcomes. - [Install the platform](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/INSTALL.md): Run the whole platform yourself: Azure Marketplace or Docker Compose, first sign-in, custom domain, upgrade and backup. - [Use cases by industry](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/USE_CASES.md): Nine complete, working catalogues - healthcare, banking, legal, retail and more - with the requests users send and where each one routes. ## Hosted platform The routing API behind an API key: decisions with trace, the OpenAI-compatible endpoint, plans and quotas. - [Platform guide](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/PLATFORM.md): Authentication, POST /api/v1/route, the OpenAI-compatible endpoint, feedback, plans, tenants, dashboard and errors. - [Platform journeys](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/PLATFORM_JOURNEYS.md): What each plan unlocks and where it lives; the first day step by step, everyday tasks by role, plan changes and offboarding. - [Model server](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/MODELS.md): Host open-weight models on your own hardware behind the Ollama and OpenAI APIs: pulls, residency with a fit check, admission queue, metrics; CPU and CUDA. - [TypeScript SDK](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/sdk-typescript.md): Routing, feedback, estimates, streaming chat and every workspace call from Node, Deno, Bun, edge runtimes and browsers. - [Marketplace](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/MARKETPLACE.md): Find, install, buy and publish agents, skills, personas, prompts and stack templates; ratings and the review lifecycle. - [Cost estimates and the MCP server](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/MCP.md): Quote a request before sending it, recommended models per use case, and the MCP server that puts the router in VS Code, Cursor, Claude and any agent. - [Content publishing for your website](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/PUBLISHING.md): Your feeds and briefs become posts written through the router, reviewed in the dashboard and delivered to your site - a signed webhook, WordPress or Ghost - or pulled as RSS; the same tools on your MCP server. - [REST API reference](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/api): Each endpoint with parameters, request and response schemas and an example request. ## Apps The router where people write: the browser extension under the composer of the chat sites and in Google Docs, the desktop bar over every application, the editor panel in VS Code, the pane in Word. - [Browser extension](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/EXTENSION.md): The pre-send advisor for ChatGPT, Claude, Gemini, Copilot and Perplexity: risks, redaction, model hints and cost quotes on the device. - [Desktop app](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/DESKTOP.md): One shortcut over any app on Windows, macOS and Linux: the routed command bar reads your selection and pastes the answer back. - [VS Code extension](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/VSCODE.md): Select code or text in the editor: task, language, size, personal data, the recommended model and its cost - then ask, explain or rewrite in place through the router. - [Word add-in](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/OFFICE.md): Select a passage in Word: task, language, size, personal data, the recommended model and its cost - then ask, explain, summarise, rewrite or proofread through the router. ## Python SDK The router as a library: targets, rules, decorators, the enterprise builder and the public API. - [User guide](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/GUIDE.md): The complete walkthrough: targets, rules, plans, real providers, execution, learning, the CLI and SKILL.md packages. - [SDK guide](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/SDK.md): Decorators for strategies, rules, signals, middleware and telemetry; settings, error handling, threading and plugins. - [Enterprise builder](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/ENTERPRISE.md): RouterBuilder: auto-learning, health, budgets, tenants, audit, stores and rollout. - [Compatibility matrix](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/COMPATIBILITY.md): Every provider, client, agent framework and adapter the router connects to - and how each connection was verified. - [Tracing and observability](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/OBSERVABILITY.md): Spans and events for every routing stage; memory, metrics, log, file and OpenTelemetry sinks; /events, /trace and /metrics. - [Agent engineering](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/AGENT_ENGINEERING.md): Prompt, harness, context, memory and agent engineering, integrations, guardrails and evals - where each lives, and the Langfuse, Phoenix, Ragas and DeepEval connections. - [Benchmarks and leaderboard recipe](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/leaderboard.md): Collect the public preference suites, train the routing SLM and publish a reproducible benchmark run. - [Published benchmark runs](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/leaderboard-results.md): The published run on MT-Bench human, PPE human and WebDev Arena against the declarative router and every baseline. - [Python API reference](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/REFERENCE.md): Every public module, class and function with its signature, generated from the source. ## Self-hosting Run the same router as a service on your own infrastructure. - [Deploy with Docker and Helm](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/deploy.md): The osr serve container image, entrypoint environment, Helm chart and health checks. ## Concepts How a request becomes a decision, the mathematics behind each score and the research the modules draw on. - [Architecture](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/ARCHITECTURE.md): How a request becomes a decision: signals, policy, strategies, utility, plans. - [Mathematics](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/MATH.md): The utility function, calibration, IRT, Bradley-Terry, LinUCB and Markov derivations. - [Research](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/RESEARCH.md): Problem statement, literature by family and which module borrows which idea. - [Open Capability Manifest](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/ocm.md): The OCM specification and JSON Schema for describing routable capabilities. ## Security Threat model, hardening and how to report a vulnerability. - [Security model](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/SECURITY.md): Threat model, guard middleware, PII handling, provenance and the red-team suite. - [External review pack](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/SECURITY_REVIEW.md): Scope, trust boundaries, the evidence the project produces and the review log for an independent reviewer. - [Reporting vulnerabilities](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/security-policy.md): Supported versions and how to report a security issue privately. ## Agent skills Agent-Skills packages (SKILL.md) for coding assistants working with OpenSmartRoute; each one is also a valid routing target. - [osr-decorator-sdk](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/skills/osr-decorator-sdk.md): Extend OpenSmartRoute in Python with the decorator SDK. - [osr-deploy-serve](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/skills/osr-deploy-serve.md): Run OpenSmartRoute as a service. - [osr-enterprise-builder](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/skills/osr-enterprise-builder.md): Assemble a production OpenSmartRoute router with RouterBuilder. - [osr-evaluation](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/skills/osr-evaluation.md): Evaluate and benchmark an OpenSmartRoute router. - [osr-integrations](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/skills/osr-integrations.md): Connect OpenSmartRoute to the outside world. - [osr-routing-catalogue](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/skills/osr-routing-catalogue.md): Define and tune an OpenSmartRoute routing catalogue. - [osr-security-hardening](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/skills/osr-security-hardening.md): Harden OpenSmartRoute deployments against prompt injection, gadget/steering attacks, PII leakage, runaway agents and untrusted tool arguments. ## Releases What changed in each version, and how versions and release channels work. - [Changelog](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/changelog.md): Release notes for every version. - [Versions and channels](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/docs/RELEASES.md): One version for every artifact, stable releases and developer previews, and how to read the build a deployment runs. ## Optional - [Full documentation](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/llms-full.txt): every page above as one Markdown file. - [Release feed](https://osr-web.kindrock-caaab1a2.centralindia.azurecontainerapps.io/feed.xml): Atom feed of releases from the changelog. - [PyPI](https://pypi.org/project/opensmartroute/): the `opensmartroute` package.