Codex 配置
按量付费的 MiMo API 和 Token Plan 均支持 Codex,可参考本文进行配置与使用。
MiMo 当前已经支持 Responses API,使用 Chat Completions API 的用户可以按照文档进行更新。
前置工作
获取凭证
支持两种使用方式,但对应的凭证获取方式不同:
| 使用方式 | 说明 | 获取方式(以下为 BASE_URL 和 API Key 均为示例) |
|---|---|---|
| 按量付费 API 调用 | 按实际使用量计费,适合轻度使用 |
前往 API Keys 创建 API Key |
| Token Plan | 固定订阅费,按套餐限量调用 |
成功订阅后,前往 Token Plan 获取专属 Base URL 和 API Key |
安装 Codex
前置要求: 需先安装 Node.js 18 或更新版本
安装命令:
npm install -g @openai/codex
验证安装(如有版本号输出,则表示安装成功):
codex --version
编辑配置文件
注意
- 在配置基本信息时,先检查是否存在
MIMO_API_KEY的环境变量,如果存在,请先清除或者将值替换为对应使用方式获取的 API Key。 - 如果希望通过
/model命令直接切换模型,可参考「延伸阅读-自定义 MiMo 模型配置」章节,配置model-catalogs.json文件。
配置文件路径如下:
-
macOS/Linux:
~/.codex/config.toml -
Windows:
用户目录\.codex\config.toml
以下为完整配置示例,model 字段可按需修改为其他支持的模型(如 mimo-v2.5)。
按量付费
1. 编辑或创建配置文件 config.toml
model = "mimo-v2.5-pro"
model_provider = "mimo"
model_reasoning_effort = "high"
# 开启模型推理摘要,如果设置为false,即使设置了 model_reasoning_effort 也不会生效
model_supports_reasoning_summaries = true
model_reasoning_summary = "none"
model_context_window = 1048576
web_search = "disabled"
[model_providers.mimo]
name = "mimo"
base_url = "https://api.xiaomimimo.com/v1"
env_key = "MIMO_API_KEY"
wire_api = "responses"
2. 配置环境变量 MIMO_API_KEY
按量付费使用 sk- 开头的 API Key。
-
macOS/Linux
echo 'export MIMO_API_KEY="sk-your-api-key-here"' >> ~/.bashrc source ~/.bashrc -
Windows (CMD)
# 在 CMD 中输入以下命令 setx MIMO_API_KEY "sk-your-api-key-here" # 成功后,打开新的命令行窗口,运行以下命令,查看环境变量是否生效。 echo %MIMO_API_KEY%
Token Plan
1. 编辑或创建配置文件 config.toml
model = "mimo-v2.5-pro"
model_provider = "mimo"
model_reasoning_effort = "high"
# 开启模型推理摘要,如果设置为false,即使设置了 model_reasoning_effort 也不会生效
model_supports_reasoning_summaries = true
model_reasoning_summary = "none"
model_context_window = 1048576
web_search = "disabled"
[model_providers.mimo]
name = "mimo"
base_url = "https://token-plan-cn.xiaomimimo.com/v1"
env_key = "MIMO_API_KEY"
wire_api = "responses"
2. 配置环境变量 MIMO_API_KEY
Token Plan 使用 tp- 开头的 API Key。
-
macOS/Linux
echo 'export MIMO_API_KEY="tp-your-api-key-here"' >> ~/.bashrc source ~/.bashrc -
Windows (CMD)
# 在 CMD 中输入以下命令 setx MIMO_API_KEY "tp-your-api-key-here" # 成功后,打开新的命令行窗口,运行以下命令,查看环境变量是否生效。 echo %MIMO_API_KEY%
使用 Codex CLI
以上配置完成后,开启一个新终端,执行以下命令启动 Codex。
codex
使用 Codex IDE 插件
Codex 配套提供 VS Code 插件,前往 VS Code 扩展市场搜索「Codex」即可完成安装。插件会自动复用本地已存在的 Codex 配置;若你从未使用过 Codex 命令行工具,请参照「编辑配置文件」章节规范完成配置。
延伸阅读
自定义 MiMo 模型配置
Codex 支持自定义模型参数配置,可针对 MiMo 模型进行精细化个性化适配。配置完成后,在 Codex CLI 中输入 /model 即可在模型列表中看到 MiMo 模型及其对应的推理档位,并支持随时切换使用。
关键字段说明
| 字段 | 作用 |
|---|---|
slug |
模型唯一内部标识,必须和后端 API 模型名称完全一致 |
display_name |
前端界面展示用模型名称,可和 slug 相同或自定义美化名称 |
description |
模型简介文案,用于客户端模型列表 hover 提示、模型详情介绍 |
default_reasoning_level |
新建会话默认推理强度档位,对于 MiMo 模型而言,none 为关闭思考,其他可选值为开启思考 |
supported_reasoning_levels |
客户端允许用户切换的推理强度配置列表,包含 effort 标识和 description 说明文本,这里给出 none 和 high 作为示例参考 |
shell_type |
工具执行环境类型,示例中使用 "shell_command",表示支持调用 Shell 命令工具 |
visibility |
模型在客户端界面的可见策略,list 为正常展示 |
supported_in_api |
该模型是否对外开放标准 API 调用,true 表示支持外部程序通过 API 调用 |
priority |
界面排序权重,数字越小排序越靠前,1 代表高优先级置顶展示 |
base_instructions |
系统提示词 |
supports_reasoning_summaries |
模型是否支持推理摘要输出。为 true 时请求携带推理参数;为 false 则清空所有推理字段,推理档位(即 reasoning_level)配置失效 |
default_reasoning_summary |
推理摘要默认输出模式,none 为不单独输出推理摘要 |
support_verbosity |
是否支持控制输出详细度,false 表示暂不支持文本详细度档位切换 |
truncation_policy |
上下文截断策略,mode 为截断单位,limit 为单次上下文最大字节上限 |
supports_parallel_tool_calls |
是否支持并行多工具调用,false 表示仅支持串行依次调用 |
supports_image_detail_original |
图片输入是否支持原图高清解析,true 表示使用原图完整分辨率 |
context_window |
模型标称总上下文窗口大小,1048576 = 1M 上下文窗口 |
max_context_window |
支持的最大上下文上限 |
effective_context_window_percent |
实际可用上下文比例,95 表示预留 5% 安全缓冲防止超出限制 |
experimental_supported_tools |
实验性功能工具白名单,空数组 [] 表示当前无额外内测工具 |
input_modalities |
支持的输入模态类型,["text", "image"] 表示支持文本 + 图片输入 |
supports_search_tool |
是否内置联网搜索工具能力,false 表示不支持联网检索 |
配置步骤
-
编辑或者创建
.codex/model-catalogs/model-catalogs.json文件,用于 MiMo 模型的详细配置(以mimo-v2.5-pro和mimo-v2.5为例){ "models": [ { "slug": "mimo-v2.5-pro", "display_name": "mimo-v2.5-pro", "description": "MiMo-v2.5-Pro: Trillion-parameter Flagship Agent Foundation", "default_reasoning_level": "high", "supported_reasoning_levels": [ { "effort": "none", "description": "Disable Thinking" }, { "effort": "high", "description": "Enabled Thinking" } ], "shell_type": "shell_command", "visibility": "list", "supported_in_api": true, "priority": 0, "base_instructions": "You are MiMo, an AI assistant developed by Xiaomi. Today's date: {date} {week}. Your knowledge cutoff date is December 2024.", "supports_reasoning_summaries": true, "default_reasoning_summary": "none", "support_verbosity": false, "truncation_policy": { "mode": "bytes", "limit": 10000 }, "supports_parallel_tool_calls": false, "supports_image_detail_original": false, "context_window": 1048576, "max_context_window": 1048576, "effective_context_window_percent": 95, "experimental_supported_tools": [], "input_modalities": ["text"], "supports_search_tool": false }, { "slug": "mimo-v2.5", "display_name": "mimo-v2.5", "description": "MiMo-V2.5: Native Omni-modal Perception Model", "default_reasoning_level": "high", "supported_reasoning_levels": [ { "effort": "none", "description": "Disable Thinking" }, { "effort": "high", "description": "Enabled Thinking" } ], "shell_type": "shell_command", "visibility": "list", "supported_in_api": true, "priority": 1, "base_instructions": "You are MiMo, an AI assistant developed by Xiaomi. Today's date: {date} {week}. Your knowledge cutoff date is December 2024.", "supports_reasoning_summaries": true, "default_reasoning_summary": "none", "support_verbosity": false, "truncation_policy": { "mode": "bytes", "limit": 10000 }, "supports_parallel_tool_calls": false, "supports_image_detail_original": true, "context_window": 1048576, "max_context_window": 1048576, "effective_context_window_percent": 95, "experimental_supported_tools": [], "input_modalities": ["text", "image"], "supports_search_tool": false } ] } -
在
config.toml文件的根级别中加上以下配置
-
macOS/Linux
model_catalog_json = "~/.codex/model-catalogs/model-catalogs.json" -
Windows
model_catalog_json = "用户目录/.codex/model-catalogs/model-catalogs.json"