Skip to content

docs: declare native web search support in Codex examples #2516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
solid-pixel wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −0
Open

docs: declare native web search support in Codex examples #2516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ name = "openai" # required — enables remote /responses/compact. Lowercase sin
base_url = "http://127.0.0.1:2455/backend-api/codex"
wire_api = "responses"
supports_websockets = true
supports_standalone_web_search = true # requires codex-lb >= 1.22.0
requires_openai_auth = true # required for codex app
```

Expand Down
1 change: 1 addition & 0 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ name = "openai" # 必填 —— 启用远程 /responses/compact。自 Codex 202
base_url = "http://127.0.0.1:2455/backend-api/codex"
wire_api = "responses"
supports_websockets = true
supports_standalone_web_search = true # 需要 codex-lb >= 1.22.0
requires_openai_auth = true # codex 应用需要
```

Expand Down
15 changes: 15 additions & 0 deletions docs/client-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,23 @@ name = "openai" # required — enables remote /responses/compact. Lowercase sin
base_url = "http://127.0.0.1:2455/backend-api/codex"
wire_api = "responses"
supports_websockets = true
supports_standalone_web_search = true # requires codex-lb >= 1.22.0
requires_openai_auth = true # required for codex app
```

### Native web search

`supports_standalone_web_search = true` declares that the custom provider supports
Codex's standalone search endpoint; it requires codex-lb >= 1.22.0.
Custom providers default this capability to `false`, so `--search` alone may not
make native search available. Use `codex --search` for live search in one session,
or set `web_search = "live"` at the top level of `config.toml` for a persistent
preference. This provider capability is separate from the experimental
`[features].standalone_web_search` flag; enabling that feature flag is not part
of this setup. The Codex version and selected model must also support standalone
search. See [OpenAI's web-search documentation](https://learn.chatgpt.com/docs/web-search)
and the [standalone search proxy specification](https://github.com/Soju06/codex-lb/blob/main/openspec/specs/responses-api-compat/spec.md#requirement-standalone-codex-web-search-is-forwarded-faithfully).

### Opting into the 872k context window

GPT-5.6 ships a 272,000-token default input budget with an 872,000-token
Expand Down Expand Up @@ -173,6 +187,7 @@ base_url = "http://127.0.0.1:2455/backend-api/codex"
wire_api = "responses"
env_key = "CODEX_LB_API_KEY"
supports_websockets = true
supports_standalone_web_search = true # requires codex-lb >= 1.22.0
requires_openai_auth = true # required for codex app
```

Expand Down
1 change: 1 addition & 0 deletions docs/examples/codex/config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ name = "openai"
base_url = "http://127.0.0.1:2455/backend-api/codex"
wire_api = "responses"
supports_websockets = true
supports_standalone_web_search = true # requires codex-lb >= 1.22.0
requires_openai_auth = true

# Opt-in only. ~/.codex/daybreak-blue.config.toml selects this provider.
Expand Down