文檔導覽
DEVELOPER DOCUMENTATION

Codex 自訂供應商設定

以獨立環境變數與 TOML 規劃 Codex 的 Responses 供應商。

先核對 Responses 相容性

網站維護中。以下為規劃中的設定範例;api.ubtl.net 是預定網域,尚未以此教學執行真實 API 測試。設定前須確認服務實際支援的 Responses 路徑、驗證方式與模型識別碼,不應將範例視為可用性證明。

Codex 的自訂供應商需要真正的 Responses 協定支援;只有 Chat Completions 相容性並不足夠。目前這份範例採用 responses,不要改成已移除的 chat 選項。先退出 Codex,備份 ~/.codex/config.toml,並確認是否使用不同設定目錄或已有其他供應商,避免覆蓋原本的登入與模型選擇。

新增供應商並隔離金鑰

將頂層模型與供應商選擇放在 TOML 的頂層,再合併供應商區塊;不要重複建立同名資料表。env_key 指向環境變數名稱,因此設定檔不必存放明文金鑰。預定 Base URL 為 https://api.ubtl.net/v1,模型仍須以實際確認的識別碼取代。此組合不應設定 requires_openai_auth 為 true,以免混入不同的驗證流程。

以下 shell 內容只是日後在本機終端機啟動的示意,佔位符不是真實金鑰。使用獨立的 UBTL_API_KEY,避免覆寫其他供應商的憑證;不要提交含有真實值的腳本、終端機紀錄或設定備份。

合併至 Codex TOML 的規劃範例 · toml
model = "YOUR_MODEL_ID"
model_provider = "ubtl"

[model_providers.ubtl]
name = "UBTL"
base_url = "https://api.ubtl.net/v1"
env_key = "UBTL_API_KEY"
wire_api = "responses"
Bash 工作階段啟動示意 · bash
export UBTL_API_KEY='YOUR_UBTL_API_KEY'
codex

重啟與分層排查

儲存設定後,在已載入環境變數的終端機重新啟動 Codex,先確認設定能解析且選用 ubtl。等服務正式確認可用後,再用空白測試資料夾及不含秘密的短提示進行最小請求,不授權無關的檔案操作。若失敗,依序檢查環境變數是否繼承、Responses 路徑是否支援及模型權限;不要用任意切換協定掩蓋錯誤。分享診斷前遮蔽金鑰,停用時還原設定備份並清除該工作階段的變數。