跳至主要內容
開發者資源
開發者資源

Codex App

在 Codex App 中使用 RunAPI 作為模型提供者，選擇與 Responses 相容的模型，並驗證連接。

檢視 Markdown

概覽

Codex 可在 Windows 和 macOS 的 ChatGPT 桌面應用程式中使用。 本指南將本地 Codex App 指向 RunAPI 的 OpenAI 相容 Responses 端點，選擇 RunAPI 模型並驗證連接。

這會更改用於生成回應和代碼的模型提供者。它不會新增 RunAPI 工具。Hosted MCP 是一個獨立的整合，有其自身的客戶端及身份驗證要求。

開始之前

以下步驟配置讀取用戶級配置的本地 Codex 客戶端。這些步驟不配置託管的 Codex 雲端任務。

儲存 API 金鑰

桌面應用程式可能不會繼承 shell 的環境變數。 建立或編輯 ~/.codex/.env，並在獨立一行新增金鑰：

DOTENV 
export RUNAPI_API_KEY=YOUR_RUNAPI_API_KEY

將此檔案存放於儲存庫之外。在 macOS 和 Linux 上，將其限制為您的使用者帳戶：

SHELL 
chmod 600 ~/.codex/.env

配置 RunAPI

開啟用戶層級的 ~/.codex/config.toml。將以下值合併至現有文件中；請勿替換不相關的設定或添加現有頂層金鑰的第二份複本：

TOML 
model = "YOUR_RUNAPI_MODEL_ID"
model_provider = "runapi"

[model_providers.runapi]
name = "RunAPI"
base_url = "https://runapi.ai/v1"
env_key = "RUNAPI_API_KEY"
wire_api = "responses"

供應商及身份驗證設定必須在使用者層級進行。Codex 會忽略專案 .codex/config.toml 中的 model_provider 及 model_providers。TOML 僅儲存環境變數名稱；API 金鑰保存於 ~/.codex/.env。

base_url 是 API 根路徑，而非操作 URL。當 wire_api = "responses" 時，Codex 發送 POST /v1/responses。請參閱 OpenAI 的自訂模型提供者配置以了解提供者合約。

選擇模型

將 YOUR_RUNAPI_MODEL_ID 替換為從模型目錄複製的確切識別符。請選擇一個提供 Responses API 的模型；僅支援 Chat Completions 不足以用於此設定。

當您更改 model 時，請完全重新啟動應用程式並開始新 任務。現有任務可能保留其啟動時的模型和供應商。

重新啟動並驗證

  1. 完全退出並重新開啟 ChatGPT 桌面應用程式。
  2. 開啟 Codex 並在代碼庫中開始一項新任務。
  3. 發送一個簡短的提示，例如 Describe this repository in one sentence.
  4. 確認 Codex 返回正常回應，並確認 RunAPI 已記錄到針對所選模型的 POST /v1/responses 請求。

首次驗證應保持簡短，以便輕鬆區分配置錯誤與任務特定行為。

新增 RunAPI 工具

上方的模型提供者將 Codex 推論路由至 RunAPI。MCP 是獨立的：它可讓支援的客戶端呼叫 RunAPI 工具進行模型探索、帳戶資訊查詢及支援的任務工作流程。

Hosted MCP 指南說明了目前支援的客戶端及身份驗證要求。Codex 專屬的 Hosted MCP 身份驗證尚未經過驗證，因此本頁不提供 Codex MCP 設定步驟。請勿以 MCP 伺服器項目取代模型提供者配置；兩者整合用途不同。

疑難排解

  • Codex 仍然使用舊的 provider： 請確認檔案為 ~/.codex/config.toml，移除重複的 model 或 model_provider 鍵，完全重啟應用程式，並開始新的任務。
  • RUNAPI_API_KEY 缺失： 請確認金鑰位於 ~/.codex/.env 中，而不只是在終端機設定檔中，然後重啟應用程式。
  • 身份驗證失敗： 請透過身份驗證指南建立或輪換標準金鑰。請勿將金鑰貼入 config.toml 或支援日誌中。
  • 請求返回 404： 請將 base_url 設定為 https://runapi.ai/v1，而非 https://runapi.ai/v1/responses。
  • 模型不可用或拒絕某個欄位： 請再次複製確切的識別碼，並確認該模型支援 Responses API 及所請求的功能。
  • Codex 選擇了不同的模型： 請檢查受信任項目的 .codex/config.toml 檔案中是否存在 model 覆蓋設定。項目設定可以選擇模型，但不能取代使用者層級的 provider。
  • CLI 正常運作但應用程式失敗： 請檢查 ~/.codex/.env，然後完全重啟應用程式。GUI 應用程式可能不會讀取僅由 shell 匯出的變數。
  • 雲端任務未使用 RunAPI： 此本機設定適用於本機 Codex 用戶端；託管的雲端任務不會讀取您電腦上的檔案。

移除 RunAPI

  1. 從 ~/.codex/config.toml 中移除 RunAPI 的 model、model_provider 和 [model_providers.runapi] 值，或恢復您之前使用的提供商值。
  2. 如沒有其他本地工具使用 RUNAPI_API_KEY，請從 ~/.codex/.env 中將其移除。
  3. 完全重新啟動應用程式並開始新任務。
  4. 當不再需要時，在 RunAPI 中撤銷專用金鑰。

後續步驟

使用 LLM API 快速入門 了解共用協定行為，使用 Responses API 參考 查看確切的請求與回應欄位。如有需要，繼續參閱模型目錄、身份驗證指南或託管 MCP。