f3router docs

English · 简体中文

f3router documentation

This is the user entry point — start here to install the gateway, call the OpenAI-compatible API, connect coding agents and understand the high-level architecture. The root README is the product overview; this index gets you running.

Guides

  • Install & deploy — quick start, Docker Compose, local development, declarative startup config, the Docker image, backups, the desktop app, where your data lives, and an FAQ on password resets, logs and uninstalling.
  • API reference — chat completions, auto:* routing strategies, streaming, tool calling, vision, Gemini Google Search grounding, embeddings, response headers, and the Anthropic Messages surface.
  • Supported agents — every agent f3router works with and its one-line setup command.
  • Clients & coding agents — OpenAI-compatible clients, recipes for Claude Code / Codex CLI / Cline / Continue / Aider / opencode / Cursor, the MCP server, editor autocomplete, and Context Handoff.
  • Prompt compression — request-side modes, safeguards, per-request controls, custom tool-output filters, statistics, and preview APIs.
  • Proxy transports — outbound proxy transports — forward vs Fetch Relay, system auto-detect, TRUST_PROXY for inbound; see Fetch Relay transport for the relay protocol and Cloudflare Worker reference.
  • Architecture & internals — how the router works, routing and operational details, what's not supported, honest limitations, and the provider Terms-of-Service review.

More

  • Android with Termux — experimental local installation using Node's built-in SQLite driver.
  • Fallback chains — named fallback-chain lifecycle, empty-chain authoritative 400, auto:<name> routing, and catalog-sync backfill.
  • Docker deployment — container configuration and persistent storage.
  • Desktop app — build and package the Electron application.
  • Contributor guide — development loop, testing expectations, and contribution policy.
  • Database migrations — create, apply, inspect, and roll back schema migrations.

Website assets in this directory