docs: custom API providers (PR-5) - #71
Merged
xjoker merged 3 commits intoAug 26, 2026
Merged
Conversation
Document provider add/list/show/remove, launch overlay, TUI two-tab add/remove, OpenRouter and DeepSeek-via-gateway, and the no-argv key contract. Wiki page plus README, command reference, architecture, and changelog. Co-authored-by: xJoker <xjoker@users.noreply.github.com>
xjoker
marked this pull request as ready for review
August 26, 2026 02:38
…models End-to-end testing against OpenRouter showed Codex enables its built-in web_search server tool by default, which most third-party models reject with HTTP 400 'Server tool request failed'. Document the top-level web_search='disabled' config (and -c override), plus the note that some reasoning models impose their own request requirements. Co-authored-by: xJoker <xjoker@users.noreply.github.com>
…etting Smoke-tested DeepSeek and Kimi (thinking + non-thinking) over OpenRouter. web_search rejection is model-specific, not universal: deepseek-v3.2, kimi-k2, and minimax-m3:free accept it (HTTP 200); gpt-oss-20b rejects it (400). Thinking models (deepseek-r1, kimi-k2-thinking) need model_reasoning_effort set or they 400 with 'Reasoning is mandatory'. Reword from 'most models' to model-specific, and document the reasoning effort override. Co-authored-by: xJoker <xjoker@users.noreply.github.com>
This was referenced Aug 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on #70 (
cursor/provider-tui-add-remove-5a91). Last PR in the custom API providers series. Retarget todevafter #67–#70 merge.What this is
User-facing documentation for saving a third-party API endpoint (OpenRouter, or another Responses-capable gateway) and launching Codex with it. No product-code changes except the wiki-page list in
tests/test_distribution_contract.rs.Pages
docs/wiki/Providers.md: add/list/show/remove, launch overlay (codex -c+ child env, zero writes to~/.codex), OpenRouter example, DeepSeek-via-gateway, disabling Codex's built-inweb_searchfor third-party models, TUI two-tab add/remove, storage (0700/0600), no-argv key contract, MCP preserved, non-goals.Server tool request failedrow), Getting started, Chinese guide, Developer onboarding.README.md/README_CN.md,docs/CHANGELOG.md.End-to-end tested against real OpenRouter
Verified with the real
codexCLI 0.149.1 and a live OpenRouter key (isolatedCODEX_HOME/CODEX_SWITCH_HOME, key never in argv, deleted after):-coverlay applied, base-config MCP survives, key injected via env only,auth.jsonnever touched.minimax/minimax-m3:free(free),mistralai/mistral-nemo(cheap),openai/gpt-4o-mini.web_searchserver tool by default; most third-party models reject it with HTTP 400Server tool request failed. Fix: top-levelweb_search = "disabled"(or-c web_search=disabled).Out of scope (still)
use/ persisting a key into liveauth.jsonVerification (local,
CODEX_SWITCH_HOME/CODEX_HOMEunset)cargo fmt --check,cargo clippy --all-targets --all-features -- -D warnings— okcargo test --all— all green (wiki link/anchor + navigation contract tests included)Format and audit CI on this stack stays red until #63 merges.