跳转到主要内容
千问云 home page
开放平台文档
客户端与工具

Codex

在 Codex 中使用 Token Plan

安装 Codex

  1. 安装或更新 Node.js（v18.0 或更高版本）。
  2. 在终端中执行以下命令安装 Codex。 
npm install -g @openai/codex
执行以下命令验证安装。 
codex --version

配置 Token Plan 团队版

修改配置文件

完整复制以下内容并粘贴到 Codex 配置文件 ~/.codex/config.toml 中。model 请选择支持的模型。
文本模型（如 qwen3.6-plus、glm-5 等）可直接使用。图像生成模型需通过 Skill 接入，参见接入图像生成模型。
model_provider = "Model_Studio_Token_Plan"
model = "qwen3.6-plus"
[model_providers.Model_Studio_Token_Plan]
name = "Model_Studio_Token_Plan"
base_url = "https://token-plan.cn-beijing.maas.aliyuncs.com/compatible-mode/v1"
env_key = "OPENAI_API_KEY"
wire_api = "responses"

Chat/Completions API（其他模型）

其他模型需通过 Chat/Completions API 接入，需安装旧版本 Codex，如 0.80.0： 
npm install -g @openai/codex@0.80.0

model_provider = "Model_Studio_Token_Plan"
model = "glm-5"
[model_providers.Model_Studio_Token_Plan]
name = "Model_Studio_Token_Plan"
base_url = "https://token-plan.cn-beijing.maas.aliyuncs.com/compatible-mode/v1"
env_key = "OPENAI_API_KEY"
wire_api = "chat"

配置环境变量

将配置文件中的 OPENAI_API_KEY 环境变量设置为 Token Plan 团队版专属 API Key。
  • macOS
  • Windows
  1. 在终端中执行以下命令，查看默认 Shell 类型。
echo $SHELL
  1. 根据 Shell 类型设置环境变量，命令如下：
  • zsh
  • bash
# 将 YOUR_API_KEY 替换为 Token Plan 团队版 API Key
echo 'export OPENAI_API_KEY="YOUR_API_KEY"' >> ~/.zshrc
  1. 在终端中执行下列命令，使环境变量生效。
  • zsh
  • bash
source ~/.zshrc

接入图像生成模型

通过 Codex 的 Skill 机制，可以调用 Token Plan 团队版的图像生成模型（qwen-image-2.0、wan2.7-image 等）。

步骤一：创建 Skill

创建文件 ~/.codex/skills/token-plan-image/SKILL.md，完整复制以下内容并粘贴。 
---
name: "token-plan-image"
description: "Generate images from text descriptions using Token Plan's image generation API (qwen-image-2.0, wan2.7-image, etc.). Activate when the user asks to draw, generate, or create an image."
---

# Token Plan Image Generation

Generate images from text prompts via the Token Plan API.

## When to use

Activate this skill when the user requests image generation.

## Pipeline

1. Extract parameters from the user's request: prompt, model (default: qwen-image-2.0), size (default: 1024*1024).
2. Call the API with curl:

\`\`\`bash
curl -s -X POST "https://token-plan.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"<model>","input":{"messages":[{"role":"user","content":[{"text":"<prompt>"}]}]},"parameters":{"size":"<size>"}}'
\`\`\`

3. Extract the image URL from the response JSON (located at output.choices[].message.content[].image).
4. Download the image with curl and report the saved file path to the user.

## Important

Do NOT attempt to view or read the generated image file. The model does not support image input and will error. Only report the file path.

步骤二：使用

在 Codex 中描述图像需求，Codex 会自动调用 token-plan-image Skill 生成图片。

使用 Codex

  1. 新建一个终端，执行以下命令进入 Codex。
codex
  1. 开始对话。

配置按量计费

将 OPENAI_API_KEY 环境变量设置为千问云 API Key。可用模型请参考支持的模型。
配置项说明
Base URLhttps://dashscope.aliyuncs.com/compatible-mode/v1
API Key千问云 API Key（格式为 sk-xxxxx），设为 OPENAI_API_KEY 环境变量
可用模型支持的模型
按量计费支持 Responses API 和 Chat/Completions API 两种接入方式，请根据使用的模型选择：

Responses API

适用于支持 OpenAI Responses API 的模型（如 qwen3.6-plus），可使用最新版 Codex。 
model_provider = "Model_Studio"
model = "qwen3.6-plus"
[model_providers.Model_Studio]
name = "Model_Studio"
base_url = "https://dashscope.aliyuncs.com/compatible-mode/v1"
env_key = "OPENAI_API_KEY"
wire_api = "responses"

Chat/Completions API

适用于仅支持 Chat/Completions API 的模型，需安装 Codex 0.80.0： 
npm install -g @openai/codex@0.80.0

model_provider = "Model_Studio"
model = "qwen3.6-plus"
[model_providers.Model_Studio]
name = "Model_Studio"
base_url = "https://dashscope.aliyuncs.com/compatible-mode/v1"
env_key = "OPENAI_API_KEY"
wire_api = "chat"

配置环境变量

  • macOS
  • Windows
  1. 在终端中执行以下命令，查看默认 Shell 类型。
echo $SHELL
  1. 根据 Shell 类型设置环境变量：
  • Zsh
  • Bash
# 将 YOUR_API_KEY 替换为千问云 API Key
echo 'export OPENAI_API_KEY="YOUR_API_KEY"' >> ~/.zshrc
  1. 执行以下命令使环境变量生效。
  • Zsh
  • Bash
source ~/.zshrc

常见问题

报错 wire_api = chat is no longer supported 怎么办？

原因：Codex 新版本使用 Responses API，不支持 wire_api = "chat" 配置。 解决方案：将 wire_api 改为 responses，并确认 base_url 配置正确： 
base_url = "https://token-plan.cn-beijing.maas.aliyuncs.com/compatible-mode/v1"
wire_api = "responses"

报错 unexpected status 401 Unauthorized 怎么办？

原因：
  • 误用了其他套餐的 API Key（如按量计费的 Key）
  • Token Plan 团队版订阅过期
  • API Key 复制不完整、有空格或拼写错误
解决方案：
  • 确认使用的是 Token Plan 团队版专属 API Key，Token Plan 团队版和按量计费的 API Key 互不相通。
  • 前往 Token Plan 团队版页面确认订阅是否过期。
  • 前往 Token Plan 团队版页面重新复制 API Key，确保完整且无空格。
  • 如以上均正常仍报错，可在 Token Plan 团队版页面重置 API Key，重置后请使用新 API Key 进行配置。

报错 unexpected status 404 Not Found 怎么办？

原因：配置文件中的 base_url 或 wire_api 填写错误。 解决方案：确认 base_url 和 wire_api 配置正确： 
base_url = "https://token-plan.cn-beijing.maas.aliyuncs.com/compatible-mode/v1"
wire_api = "responses"