From 428dfcdf2d7702379217efd11f2754ba03dfd7a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lenine=20J=C3=BAnior?= Date: Wed, 20 May 2026 07:36:01 -0400 Subject: [PATCH] docs(agentrouter): recommend native provider as the simple path (#2429) Merged into release/v3.8.0 --- docs/AGENTROUTER.md | 35 ++++++++++++++++++++++++++++++----- 1 file changed, 30 insertions(+), 5 deletions(-) diff --git a/docs/AGENTROUTER.md b/docs/AGENTROUTER.md index 2333bc0883..715e19385e 100644 --- a/docs/AGENTROUTER.md +++ b/docs/AGENTROUTER.md @@ -6,11 +6,36 @@ designed as a drop-in `ANTHROPIC_BASE_URL` replacement for the official Claude C client, so it only accepts traffic that matches the Claude Code wire image (specific User-Agent, `anthropic-beta` flags, Stainless SDK headers, etc.). -OmniRoute supports AgentRouter through the **Claude Code compatible** provider type -(`anthropic-compatible-cc-*`), which speaks the Anthropic Messages API with the -correct wire image. A generic `openai-compatible-chat` provider pointing at -`https://agentrouter.org` will **not** work — the upstream WAF rejects requests that -do not look like Claude Code. +## Quick start — use the native `agentrouter` provider (recommended) + +For most users, **no special setup is required**. OmniRoute ships a built-in +`agentrouter` provider with the full Claude Code wire image already baked in (see +`open-sse/config/providerRegistry.ts` → `agentrouter`). To use it: + +1. Open **Dashboard → Providers → Add Provider**. +2. Select **AgentRouter** from the list. +3. Paste your `sk-...` API key and save. + +That's it — no environment variables, no custom provider type. Built-in models +include `claude-opus-4-6`, `claude-haiku-4-5-20251001`, `glm-5.1`, and +`deepseek-v3.2`. + +The rest of this guide covers the **advanced path**: using the +`anthropic-compatible-cc-*` provider type. Use that when you need more control +over the wire image — for example, when connecting to other AgentRouter-style +relays that are not yet in the native provider registry, or when overriding the +base URL, chat path, or header set. + +--- + +## Advanced: connecting via the Claude Code compatible provider type + +OmniRoute also supports AgentRouter (and similar relays) through the **Claude Code +compatible** provider type (`anthropic-compatible-cc-*`), which speaks the +Anthropic Messages API with the correct wire image. A generic +`openai-compatible-chat` provider pointing at `https://agentrouter.org` will +**not** work — the upstream WAF rejects requests that do not look like Claude +Code. ---