Docs
Documentation
Everything you need to install, configure, and run kRouter in production.
Getting Started
Install kRouter, connect a first provider, and point Claude Code, Codex or any OpenAI-compatible tool at it. Takes about five minutes.
ReadCombos & fallback
Put several models behind one name. kRouter falls back from one to the next, rotates them, or asks a panel of models and merges the answers.
ReadAPI Reference
kRouter's endpoints on localhost:20128: OpenAI Chat Completions, Anthropic Messages, the Responses API used by Codex, models, media, and auth.
ReadReference
API Reference
kRouter's endpoints on localhost:20128: OpenAI Chat Completions, Anthropic Messages, the Responses API used by Codex, models, media, and auth.
Architecture
What happens to one request inside kRouter: access check, format detection, routing, translation, token savers, the upstream call and the reply.
CLI reference
Every flag the krouter command accepts, what foreground and tray mode do, exit codes, and how to run kRouter under PM2 or systemd.
Concepts
Core concepts
Providers, combos, account routing, token savers, MITM mode, quota tracking, the response cache and remote access: the eight ideas behind kRouter.
Providers
Connect 95+ AI providers to kRouter: OAuth subscriptions, free services, free-tier and pay-per-token API keys, and browser-cookie logins.
Combos & fallback
Put several models behind one name. kRouter falls back from one to the next, rotates them, or asks a panel of models and merges the answers.
Operating
Deployment
Run kRouter on a server with npm and PM2, in Docker, with Docker Compose and the Presidio sidecar, or from source. Environment variables and HTTPS.
Security
Who can reach kRouter, how API keys and dashboard logins work, what it stores in plain text, how MITM certificates work, and the security releases to have.
Troubleshooting
Fixes for common kRouter problems: banned or rate-limited accounts, OAuth sign-ins, MITM certificates, localhost and Cursor, Docker logins and the CLI.
Start here
Guide
Token savers: RTK, Caveman, Ponytail, Headroom, PXPIPE
Five ways kRouter can shrink a request before it reaches the provider. Only RTK is on by default. What each saver does, what it needs, and its limits.
The Zenith Routing Engine
How kRouter picks which of your accounts serves a request: Zenith scoring, conversation stickiness, cooldowns, and the round-robin, P2C and random options.
Multimodal & Agent Skills
kRouter's endpoints beyond chat: speech, transcription, embeddings, images, video, web search and fetch, plus Agent Skills that teach agents to use them.