RequestBeam

文档目录

RequestBeam 文档

Codex 接入

在 Codex CLI、VS Code 插件或桌面 App 中使用 RequestBeam 的 OpenAI Responses 兼容接口。

Codex 使用 OpenAI Responses 协议调用模型。配置时把模型提供方设置为本页显示的 OpenAI 兼容 Base URL。

text
Codex base_url: https://api.requestbeam.com/openai

准备工作

你需要先准备一个可用的 RequestBeam API Key。该 Key 会写入本机 Codex 配置目录，请不要提交到仓库、日志或截图中。

Codex 的配置目录通常是：

  • macOS / Linux：~/.codex/
  • Windows：%userprofile%\.codex\

如果目录或文件不存在，可以先创建：

bash
mkdir -p ~/.codex
touch ~/.codex/config.toml

Windows CMD 可以使用：

bat
mkdir %userprofile%\.codex
type nul > %userprofile%\.codex\config.toml

备份配置

如果你已经使用过 Codex，建议先备份当前配置：

bash
cp ~/.codex/config.toml ~/.codex/config.toml.bak
cp ~/.codex/auth.json ~/.codex/auth.json.bak

修改 config.toml

打开 ~/.codex/config.toml，加入或调整以下配置：

toml
model_provider = "requestbeam"
model = "gpt-5.4"
review_model = "gpt-5.4"
model_reasoning_effort = "high"
disable_response_storage = true
network_access = "enabled"

[model_providers.requestbeam]
name = "RequestBeam"
base_url = "https://api.requestbeam.com/openai"
wire_api = "responses"
requires_openai_auth = true
supports_websockets = true
websocket_connect_timeout_ms = 15000

[features]
responses_websockets = true

base_url 的规则是：本页显示的公开 API Base URL + /openai。

如果你的 config.toml 里已经有 [marketplaces.*]、[plugins.*] 或其他工具配置，请保留它们，只新增或修改上面的 Codex 模型提供方配置。

WebSocket 模式说明

开启 supports_websockets = true 和 responses_websockets = true 后，将使用下方 Responses WebSocket 入口：

text
https://api.requestbeam.com/openai/responses

如果 API Base URL 使用 https://，Codex 会使用对应的 wss:// 连接。

该 WebSocket 模式是 Codex 专用的 Responses-over-WebSocket bridge：

  • 支持 response.create
  • 支持 response.cancel
  • 返回 response.completed
  • 同时保留 response.processed 兼容事件

它不是 OpenAI Realtime API，不支持 session.update、conversation.item.*、input_audio_buffer.*、音频流、二进制消息或 Realtime 的嵌套信封。

如果用户的网络代理、公司网关或旧版本 Codex 无法建立 WebSocket，可以把配置临时改成：

toml
[model_providers.requestbeam]
supports_websockets = false

[features]
responses_websockets = false

关闭后 Codex 会回退到 HTTP POST https://api.requestbeam.com/openai/responses。Compact 是独立能力：当前列出的 五个 GPT 模型尚无已验证的 Compact 通道，切换 HTTP/WebSocket 并不会启用上下文压缩。 使用这些路由时，请在达到上下文限制前开启新会话，不要依赖自动长上下文压缩。

response.cancelled 仅确认本地收到了取消请求，不表示上游已退款。上游结果未知的请求 会保留预扣，直到核实实际用量或失败结果。

写入 API Key

把 YOUR_REQUESTBEAM_API_KEY 替换成你自己的 RequestBeam API Key 后执行：

bash
echo '{"OPENAI_API_KEY":"YOUR_REQUESTBEAM_API_KEY"}' > ~/.codex/auth.json

Windows CMD 可以使用：

bat
echo {"OPENAI_API_KEY":"YOUR_REQUESTBEAM_API_KEY"} > %userprofile%\.codex\auth.json

重启并测试

保存配置后完全退出 Codex，再重新打开。

CLI 可以用下面的命令测试：

bash
codex "你好，请用一句话回复当前模型是否可用"

VS Code 插件或桌面 App 需要完全退出应用后重新打开，再发起一次普通对话。

常见问题

  • base_url 必须是本页显示的公开 API Base URL 加 /openai。
  • wire_api 必须是 responses，不要改成 chat。
  • Compact 不可用表示没有已验证的通道，修改本地 token 阈值不能启用该能力。
  • RequestBeam 同时支持 HTTP Responses 和 Codex Responses WebSocket。推荐保持 supports_websockets = true 和 responses_websockets = true；如果本地 Codex 版本或网络代理不支持 WebSocket，可以临时改回 supports_websockets = false 使用 HTTP。
  • auth.json 必须是合法 JSON，键名必须是 OPENAI_API_KEY。
  • 如果返回 401 或 invalid key，请确认 API Key 有效，并且没有被旧的本地 key 覆盖。
  • 如果返回模型不可用，请查询 GET https://api.requestbeam.com/v1/models，把 model 和 review_model 设为实际可见的 GPT 模型。示例默认使用 gpt-5.4；gpt-5.3-codex 和 gpt-5.6-luna 当前未启用。
  • 修改配置后要完全退出 Codex 进程再重开，仅关闭窗口可能不会重新读取 auth.json。
  • POST https://api.requestbeam.com/openai/responses：RequestBeam 公开推荐的 Responses 兼容接口。
  • POST https://api.requestbeam.com/openai/responses/compact：必须有明确启用的 Compact 通道，否则在预扣前返回 503；支持的通道返回 response.compaction。
  • WS /openai/responses：Responses WebSocket 兼容入口，支持 response.create、response.cancel，返回 response.completed，并保留 response.processed 兼容事件。
  • WS /openai/responses/compact：使用相同的 Compact 能力检查和上游接口；WebSocket 握手成功不代表模型支持 Compact。