> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mixroute.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Codex

## 1. 介绍

本文档旨在指导用户将 **Codex CLI** 成功接入 **Mixroute**。Codex CLI 是一款运行在终端中的命令行 AI 辅助编程工具。通过修改其官方的配置目录 `~/.codex` 下的配置文件，您可以建立稳定且易于管理的多模型接入环境。

## 2. 接入前的准备

在进行配置之前，请确保您已经完成了以下准备工作：

1. **安装 Codex CLI**：确保您的开发环境中已经全局安装了该工具包。
2. **获取 Mixroute 凭证 (API Key)**：
   * 访问 Mixroute 官方控制台并注册/登录您的账号。
   * 找到 API 密钥管理页面，生成并复制您的专属 **API Key**（通常以 `sk-` 开头）。
3. **确认网络连通性**：确保您的开发设备当前网络环境可以正常访问 Mixroute 的服务地址：`https://api.mixroute.ai`。

## 3. 配置阶段

Codex CLI 的核心配置位于用户目录下的 `.codex` 文件夹中。配置主要涉及两个文件：`config.toml` (负责接口与模型参数) 和 `auth.json` (负责安全存储密钥)。

### 3.1 找到或创建配置目录

**Windows 用户：** 键盘按下 `Win+R` 键，输入 `%userprofile%\.codex` 后回车。

**MacOS / Linux 用户：** 在终端输入或通过文件管理器访问 `~/.codex`。

*重要提示：如果您是首次安装 Codex CLI，该目录或其中的文件可能不存在，请手动创建该目录及以下提到的两个文件。*

### 3.2 配置 Config.toml

创建或编辑 `.codex/config.toml` 文件，将以下 Mixroute 的配置内容复制并保存：

```toml theme={null}
# 设置全局默认的提供商为 mixroute
model_provider = "mixroute"
# 设置默认使用的模型（根据 Mixroute 平台支持的模型填写，例如 gpt-4o, claude-sonnet-5 等）
model = "gpt-5.5"
model_reasoning_effort = "xhigh"
disable_response_storage = true
model_verbosity = "high"

[model_providers.mixroute]
name = "mixroute API Gateway"
base_url = "https://api.mixroute.ai/v1"
# 使用兼容的 chat 接口
wire_api = "chat"
# 第三方网关建议关闭强制 sk- 验证
requires_openai_auth = false
```

> **注意：**
>
> 1. `base_url` 必须以 `/v1` 结尾，且不要带尾随斜杠。
> 2. `wire_api` 建议保持为 `"chat"`，因为大多数第三方中转网关实现的是 `/chat/completions`。如果遇到 404 错误，可尝试修改为 `"responses"` 视平台具体兼容情况而定。

### 3.3 配置 auth.json

创建或编辑 `.codex/auth.json` 文件。为了安全，不要将 API Key 直接写在 TOML 文件中，而是存放在此 JSON 文件里：

```json theme={null}
{
  "OPENAI_API_KEY": "sk-您的Mixroute密钥xxxxxxxxxxxx"
}
```

请将 `"sk-您的Mixroute密钥xxxxxxxxxxxx"` 替换为您在准备阶段获取的真实 Mixroute API Key。

## 4. 验证与测试

配置完成后，请在终端中唤起 Codex CLI，进行对话测试：

```bash theme={null}
codex
```

当终端出现交互界面时，尝试输入一段简单的测试提示词（例如：“你好，请写一个 Python 的 hello world 脚本”）。

* 如果 Codex 能够正常响应，则说明接入 Mixroute 已成功。
* 如果遇到报错（如未授权或连线失败），请仔细检查 `auth.json` 中的密钥格式是否正确（包含双引号），以及 `config.toml` 中的 `base_url` 是否准确填写了 `https://api.mixroute.ai/v1`。