接入文档 / 客户端

Codex CLI

在 config.toml 添加供应商，使用 Responses 接口。

配置

编辑 ~/.codex/config.toml，并在 shell 中 export COMPASS_API_KEY=sk-你的密钥。Codex CLI 使用 Responses 接口，wire_api 需设为 responses。

export COMPASS_API_KEY="sk-你的密钥"

# ~/.codex/config.toml
model = "gpt-6.1-sol"
model_provider = "compass"

[model_providers.compass]
name = "CompassAPI"
base_url = "https://api.compassapi.ai/v1"
env_key = "COMPASS_API_KEY"
wire_api = "responses"

把 sk-你的密钥 换成控制台「API 密钥」页创建的密钥。登录后在控制台的 「接入文档」页，示例会自动填入你的密钥。

注意事项

• wire_api 必须是 responses：Codex CLI 只使用 Responses 接口。
• env_key 填的是环境变量名，不是密钥本身；export 之后需要在新终端里重新运行 codex。

验证

发一条简单的请求，然后打开控制台「用量」，能看到这次调用的模型、Tokens 和费用，就说明接通了。报错时对照错误码与限流。