diff --git a/rust/README.md b/rust/README.md index 53ebfc744e..f615c741e6 100644 --- a/rust/README.md +++ b/rust/README.md @@ -110,13 +110,27 @@ Primary artifacts: ## Model Aliases -Short names resolve to the latest model versions: - -| Alias | Resolves To | -|-------|------------| -| `opus` | `claude-opus-4-7` | -| `sonnet` | `claude-sonnet-4-6` | -| `haiku` | `claude-haiku-4-5-20251213` | +Short model aliases resolve to canonical model IDs. Because the router selects a +provider from the resolved model, an alias also determines which backend and +credentials are used — choose the alias for the provider you have an API key for. +Alias resolution is case-insensitive (`OPUS` behaves the same as `opus`). + +| Alias | Resolves To | Provider | Auth env var | +|-------|-------------|----------|--------------| +| `opus` | `claude-opus-4-7` | Anthropic | `ANTHROPIC_API_KEY` | +| `sonnet` | `claude-sonnet-4-6` | Anthropic | `ANTHROPIC_API_KEY` | +| `haiku` | `claude-haiku-4-5-20251213` | Anthropic | `ANTHROPIC_API_KEY` | +| `grok`, `grok-3` | `grok-3` | xAI | `XAI_API_KEY` | +| `grok-mini`, `grok-3-mini` | `grok-3-mini` | xAI | `XAI_API_KEY` | +| `grok-2` | `grok-2` | xAI | `XAI_API_KEY` | +| `kimi` | `kimi-k2.5` | DashScope (OpenAI-compatible) | `DASHSCOPE_API_KEY` | + +Anthropic aliases track the latest published model versions. xAI models honor +`XAI_BASE_URL` and Kimi honors `DASHSCOPE_BASE_URL` for base-URL overrides. Alias +resolution is implemented in `resolve_model_alias` +([`crates/api/src/providers/mod.rs`](./crates/api/src/providers/mod.rs)); for +provider-specific request handling see +[`../docs/MODEL_COMPATIBILITY.md`](../docs/MODEL_COMPATIBILITY.md). ## CLI Flags and Commands