Yomi APIYomi API帮助文档 返回控制台

English

Yomi API / 帮助文档 / Codex 命令行

快速接入 Agent

Codex 命令行

Codex 是运行在终端里的 AI 编程代理。通过一份 config.toml 把服务商指向 Yomi API,即可用 gpt-5.6-sol、gpt-5.6-terra 等模型完成编码任务。

前置准备

  • Node.js:18 或更高版本。
  • API 密钥:在控制台「秘钥管理」创建并复制保存,密钥仅创建时可见。
  • 密钥分组(关键):gpt-5.6 系列在「GPT 特惠线路优化」「GPT 特惠线路2」「GPT Plus线路」「GPT Pro 高性能线路」「GPT-特价测试」等分组可用。创建密钥时请选择包含对应模型的分组;选了不支持的分组,调用会返回「无可用渠道」。

安装

通过 npm 全局安装,各平台命令相同:

npm install -g @openai/codex

执行以下命令,输出版本号即安装成功:

codex --version

配置 Yomi API

Codex 的配置文件位于用户目录下,不存在时手动创建:

  • macOS / Linux:~/.codex/config.toml
  • Windows:%USERPROFILE%\.codex\config.toml

写入以下内容:

model = "gpt-5.6-sol"
model_provider = "yomi"

[model_providers.yomi]
name = "Yomi API"
base_url = "https://api.yomiapi.com/v1"
env_key = "YOMI_API_KEY"
wire_api = "responses"

各字段含义:model 为默认模型,填平台目录 id(如 gpt-5.6-sol,也可换 claude-sonnet-5、gpt-5.6-terra);base_url 指向平台的 OpenAI 兼容前缀;env_key 表示密钥从环境变量 YOMI_API_KEY 读取;wire_api = "responses" 表示走 /v1/responses 接口。

密钥通过环境变量注入,请勿把密钥明文写进 config.toml,这样分享或提交配置文件时不会泄露密钥。

macOS / Linux 设置密钥

将以下内容追加到 ~/.zshrc(使用 bash 的系统为 ~/.bashrc),保存后运行 source ~/.zshrc:

export YOMI_API_KEY=YOUR_API_KEY

Windows 设置密钥

执行以下命令,然后关闭并重新打开终端使其生效:

setx YOMI_API_KEY "YOUR_API_KEY"

开始使用与验证

进入您的项目目录,启动 Codex:

codex
  1. 输入一个简单任务,例如「为当前目录写一个 .gitignore」,能正常返回即说明链路可用。
  2. 登录控制台,在用户中心「用量统计」中看到对应调用记录,说明请求确实经由 Yomi API。

常见问题

wire_api 应该填 responses 还是 chat?

平台支持 OpenAI Responses API(/v1/responses),推荐 wire_api = "responses"。如个别版本出现兼容问题,可改为 "chat",改走 /v1/chat/completions。

提示密钥无效怎么办?

配置中 env_key 指定从环境变量 YOMI_API_KEY 读取密钥:确认该变量已设置、终端已重新打开,且密钥为「秘钥管理」中的有效密钥。

提示模型不可用怎么办?

model 需填平台目录 id(如 gpt-5.6-sol),不要填显示名;同时确认密钥所属分组包含该模型,可用模型见控制台「模型服务」。