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

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 時，請完全重新啟動應用程式並開始新的 Task。現有 Task 可能會保留其啟動時所使用的模型與提供者。

重新啟動並驗證

  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 參考。如有需要，請繼續參閱模型目錄、身分驗證指南或 Hosted MCP。