Skip to content

Commit f17e121

Browse files
committed
docs: keep openai model route examples canonical
1 parent 252f3b2 commit f17e121

3 files changed

Lines changed: 21 additions & 24 deletions

File tree

docs/gateway/config-agents.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ Time format in system prompt. Default: `auto` (OS preference).
387387
- `toolProgressDetail`: detail mode for `/verbose` tool summaries and progress-draft tool lines. Values: `"explain"` (default, compact human labels) or `"raw"` (append raw command/detail when available). Per-agent `agents.list[].toolProgressDetail` overrides this default.
388388
- `reasoningDefault`: default reasoning visibility for agents. Values: `"off"`, `"on"`, `"stream"`. Per-agent `agents.list[].reasoningDefault` overrides this default. Configured reasoning defaults are only applied for owners, authorized senders, or operator-admin gateway contexts when no per-message or session reasoning override is set.
389389
- `elevatedDefault`: default elevated-output level for agents. Values: `"off"`, `"on"`, `"ask"`, `"full"`. Default: `"on"`.
390-
- `model.primary`: format `provider/model` (e.g. `openai/gpt-5.5` for API-key access or `openai-codex/gpt-5.5` for Codex OAuth). If you omit the provider, OpenClaw tries an alias first, then a unique configured-provider match for that exact model id, and only then falls back to the configured default provider (deprecated compatibility behavior, so prefer explicit `provider/model`). If that provider no longer exposes the configured default model, OpenClaw falls back to the first configured provider/model instead of surfacing a stale removed-provider default.
390+
- `model.primary`: format `provider/model` (e.g. `openai/gpt-5.5` for OpenAI API-key or Codex OAuth access). If you omit the provider, OpenClaw tries an alias first, then a unique configured-provider match for that exact model id, and only then falls back to the configured default provider (deprecated compatibility behavior, so prefer explicit `provider/model`). If that provider no longer exposes the configured default model, OpenClaw falls back to the first configured provider/model instead of surfacing a stale removed-provider default.
391391
- `models`: the configured model catalog and allowlist for `/model`. Each entry can include `alias` (shortcut) and `params` (provider-specific, for example `temperature`, `maxTokens`, `cacheRetention`, `context1m`, `responsesServerCompaction`, `responsesCompactThreshold`, `chat_template_kwargs`, `extra_body`/`extraBody`).
392392
- Safe edits: use `openclaw config set agents.defaults.models '<json>' --strict-json --merge` to add entries. `config set` refuses replacements that would remove existing allowlist entries unless you pass `--replace`.
393393
- Provider-scoped configure/onboarding flows merge selected provider models into this map and preserve unrelated providers already configured.
@@ -434,16 +434,16 @@ model, see [Agent runtimes](/concepts/agent-runtimes).
434434

435435
**Built-in alias shorthands** (only apply when the model is in `agents.defaults.models`):
436436

437-
| Alias | Model |
438-
| ------------------- | ------------------------------------------ |
439-
| `opus` | `anthropic/claude-opus-4-6` |
440-
| `sonnet` | `anthropic/claude-sonnet-4-6` |
441-
| `gpt` | `openai/gpt-5.5` or `openai-codex/gpt-5.5` |
442-
| `gpt-mini` | `openai/gpt-5.4-mini` |
443-
| `gpt-nano` | `openai/gpt-5.4-nano` |
444-
| `gemini` | `google/gemini-3.1-pro-preview` |
445-
| `gemini-flash` | `google/gemini-3-flash-preview` |
446-
| `gemini-flash-lite` | `google/gemini-3.1-flash-lite-preview` |
437+
| Alias | Model |
438+
| ------------------- | -------------------------------------- |
439+
| `opus` | `anthropic/claude-opus-4-6` |
440+
| `sonnet` | `anthropic/claude-sonnet-4-6` |
441+
| `gpt` | `openai/gpt-5.5` |
442+
| `gpt-mini` | `openai/gpt-5.4-mini` |
443+
| `gpt-nano` | `openai/gpt-5.4-nano` |
444+
| `gemini` | `google/gemini-3.1-pro-preview` |
445+
| `gemini-flash` | `google/gemini-3-flash-preview` |
446+
| `gemini-flash-lite` | `google/gemini-3.1-flash-lite-preview` |
447447

448448
Your configured aliases always win over defaults.
449449

docs/help/faq-models.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ troubleshooting, see the main [FAQ](/help/faq).
2121
agents.defaults.model.primary
2222
```
2323

24-
Models are referenced as `provider/model` (example: `openai/gpt-5.5` or `openai-codex/gpt-5.5`). If you omit the provider, OpenClaw first tries an alias, then a unique configured-provider match for that exact model id, and only then falls back to the configured default provider as a deprecated compatibility path. If that provider no longer exposes the configured default model, OpenClaw falls back to the first configured provider/model instead of surfacing a stale removed-provider default. You should still **explicitly** set `provider/model`.
24+
Models are referenced as `provider/model` (example: `openai/gpt-5.5` or `anthropic/claude-sonnet-4-6`). If you omit the provider, OpenClaw first tries an alias, then a unique configured-provider match for that exact model id, and only then falls back to the configured default provider as a deprecated compatibility path. If that provider no longer exposes the configured default model, OpenClaw falls back to the first configured provider/model instead of surfacing a stale removed-provider default. You should still **explicitly** set `provider/model`.
2525

2626
</Accordion>
2727

@@ -159,8 +159,8 @@ troubleshooting, see the main [FAQ](/help/faq).
159159
<Accordion title="How do I configure fast mode for GPT 5.5?">
160160
Use either a session toggle or a config default:
161161

162-
- **Per session:** send `/fast on` while the session is using `openai/gpt-5.5` or `openai-codex/gpt-5.5`.
163-
- **Per model default:** set `agents.defaults.models["openai/gpt-5.5"].params.fastMode` or `agents.defaults.models["openai-codex/gpt-5.5"].params.fastMode` to `true`.
162+
- **Per session:** send `/fast on` while the session is using `openai/gpt-5.5`.
163+
- **Per model default:** set `agents.defaults.models["openai/gpt-5.5"].params.fastMode` to `true`.
164164

165165
Example:
166166

@@ -271,7 +271,7 @@ troubleshooting, see the main [FAQ](/help/faq).
271271

272272
- `opus` → `anthropic/claude-opus-4-6`
273273
- `sonnet` → `anthropic/claude-sonnet-4-6`
274-
- `gpt` → `openai/gpt-5.5` for API-key setups, or `openai-codex/gpt-5.5` when configured for Codex OAuth
274+
- `gpt` → `openai/gpt-5.5`
275275
- `gpt-mini` → `openai/gpt-5.4-mini`
276276
- `gpt-nano` → `openai/gpt-5.4-nano`
277277
- `gemini` → `google/gemini-3.1-pro-preview`

docs/providers/openai.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ Choose your preferred auth method and follow the setup steps.
330330

331331
OpenClaw treats model metadata and the runtime context cap as separate values.
332332

333-
For `openai-codex/gpt-5.5` through Codex OAuth:
333+
For `openai/gpt-5.5` through the Codex OAuth catalog:
334334

335335
- Native `contextWindow`: `1000000`
336336
- Default runtime `contextTokens` cap: `272000`
@@ -356,7 +356,7 @@ Choose your preferred auth method and follow the setup steps.
356356
### Catalog recovery
357357

358358
OpenClaw uses upstream Codex catalog metadata for `gpt-5.5` when it is
359-
present. If live Codex discovery omits the `openai-codex/gpt-5.5` row while
359+
present. If live Codex discovery omits the `gpt-5.5` row while
360360
the account is authenticated, OpenClaw synthesizes that OAuth model row so
361361
cron, sub-agent, and configured default-model runs do not fail with
362362
`Unknown model`.
@@ -502,7 +502,7 @@ See [Video Generation](/tools/video-generation) for shared tool parameters, prov
502502

503503
## GPT-5 prompt contribution
504504

505-
OpenClaw adds a shared GPT-5 prompt contribution for GPT-5-family runs across providers. It applies by model id, so `openai-codex/gpt-5.5`, `openai/gpt-5.5`, `openrouter/openai/gpt-5.5`, `opencode/gpt-5.5`, and other compatible GPT-5 refs receive the same overlay. Older GPT-4.x models do not.
505+
OpenClaw adds a shared GPT-5 prompt contribution for GPT-5-family runs across providers. It applies by model id, so `openai/gpt-5.5`, legacy pre-repair refs such as `openai-codex/gpt-5.5`, `openrouter/openai/gpt-5.5`, `opencode/gpt-5.5`, and other compatible GPT-5 refs receive the same overlay. Older GPT-4.x models do not.
506506

507507
The bundled native Codex harness uses the same GPT-5 behavior and heartbeat overlay through Codex app-server developer instructions, so `openai/gpt-5.x` sessions forced through `agentRuntime.id: "codex"` keep the same follow-through and proactive heartbeat guidance even though Codex owns the rest of the harness prompt.
508508

@@ -790,7 +790,7 @@ the Server-side compaction accordion below.
790790

791791
<AccordionGroup>
792792
<Accordion title="Transport (WebSocket vs SSE)">
793-
OpenClaw uses WebSocket-first with SSE fallback (`"auto"`) for both `openai/*` and `openai-codex/*`.
793+
OpenClaw uses WebSocket-first with SSE fallback (`"auto"`) for `openai/*`.
794794

795795
In `"auto"` mode, OpenClaw:
796796
- Retries one early WebSocket failure before falling back to SSE
@@ -812,9 +812,6 @@ the Server-side compaction accordion below.
812812
"openai/gpt-5.5": {
813813
params: { transport: "auto" },
814814
},
815-
"openai-codex/gpt-5.5": {
816-
params: { transport: "auto" },
817-
},
818815
},
819816
},
820817
},
@@ -828,7 +825,7 @@ the Server-side compaction accordion below.
828825
</Accordion>
829826

830827
<Accordion title="WebSocket warm-up">
831-
OpenClaw enables WebSocket warm-up by default for `openai/*` and `openai-codex/*` to reduce first-turn latency.
828+
OpenClaw enables WebSocket warm-up by default for `openai/*` to reduce first-turn latency.
832829

833830
```json5
834831
// Disable warm-up
@@ -848,7 +845,7 @@ the Server-side compaction accordion below.
848845
</Accordion>
849846

850847
<Accordion title="Fast mode">
851-
OpenClaw exposes a shared fast-mode toggle for `openai/*` and `openai-codex/*`:
848+
OpenClaw exposes a shared fast-mode toggle for `openai/*`:
852849

853850
- **Chat/UI:** `/fast status|on|off`
854851
- **Config:** `agents.defaults.models["<provider>/<model>"].params.fastMode`

0 commit comments

Comments
 (0)