Get API

GET API · 開發者整合

將 Codex 連接到桌面上和 CLI 中的 Get API

Codex CLI 目前支援使用 base_url、env_key 和 wire_api =「responses」(唯一支援的連線值)的自訂模型提供者。 Get API Codex 配置使用 https://relay-api.getapi.pro/v1 和來自相同網站控制台的金鑰;從目前目錄中選擇模型。验证后的桌面流程可以使用 CCSwitch 选择 Provider,然后完成 Codex 重启。

首先确认Codex和Responses合约

目前的 Codex 配置參考支援自訂提供程序,並將回應列為唯一的 wire_api 值。 Get API 还注册了 /v1/responses 路由,因此本指南使用响应配置,而不是将聊天端点视为替代证据。

  • 配置前运行codex --version
  • 將 Provider 設定放在使用者等級 config.toml 中
  • 从当前 Get API 目录中选择型号

將金鑰、位址和型號保留在一種配置中

金鑰來自 getapi.pro 控制台,基本 URL 使用relay-api.getapi.pro,模型必須是該金鑰目前可用的識別碼。混合其他服務或舊螢幕截圖可能會導致身份驗證和路由失敗。

  • 将环境变量名称与 env_key 匹配
  • 将 /v1 保留在基本 URL 中
  • 切勿将真正的密钥放在 config.toml 中

切換後重新啟動並使用通過/失敗檢查

正在運行的用戶端可能無法重新載入 CCSwitch 或檔案變更。完全退出Codex,重新開啟它,發送一個不依賴專案上下文的簡單任務,並在失敗時檢查實際的Provider、模型和狀態。

  • 退出每個正在執行的 Codex 進程
  • 首先使用一個最小任務
  • 記錄HTTP狀態而不是盲目重試

配置 Codex 供應商

CCSwitch 桌面路徑和 CLI 路徑共用相同的 Get API 金鑰和基本 URL。

  1. 從目前官方入口安裝Codex並檢查

    在目前Codex官方安裝頁面選擇適合您作業系統的方法,然後執行codex --version來驗證指令。

  2. 為 Codex 建立 Get API 金鑰

    在主網站控制台中建立金鑰,選擇到達目標模型的目前群組,然後從目錄中複製可用的模型識別碼。

  3. 設定環境變數和使用者配置

    將真實金鑰儲存為 GETAPI_PRO_API_KEY 並將下面的 Provider 新增至使用者級 config.toml 中。不要將憑證提交給項目。

  4. 在CCSwitch中選擇Codex

    對於桌面路徑,開啟 CCSwitch 中的 Codex Provider 區域,並確認 Get API 配置已啟用。

    CCSwitch 中的 Codex 提供者選擇器
    管理Provider之前,在CCSwitch中選擇Codex。參考 UI 以中文顯示。
  5. 完全退出並重新啟動Codex

    儲存或切換提供者後,退出每個正在執行的 Codex 進程並重新開啟用戶端,以便它讀取新配置。

  6. 發送最小任務並驗證結果

    從一個簡單的任務開始。失敗時,檢查環境變數、基本 URL、模型、回應路由和狀態代碼。

用戶級 Codex config.toml

將 your-model-name 替換為密鑰目前可存取的模型。僅將真實憑證保留在 GETAPI_PRO_API_KEY 環境變數中。

model_provider = "getapi_pro"
model = "your-model-name"

[model_providers.getapi_pro]
name = "GetAPI Pro"
base_url = "https://relay-api.getapi.pro/v1"
env_key = "GETAPI_PRO_API_KEY"
wire_api = "responses"

Codex整合故障排除

按狀態診斷;請勿同時重新安裝、旋轉鑰匙和切換型號。

症狀檢查行動成功檢查
缺少 codex 命令安裝完成並刷新終端PATH使用目前官方安裝頁面或重新開啟終端,然後執行 codex --version該命令列印版本訊息
401GETAPI_PRO_API_KEY 存在且符合 env_key在受控環境下再次設定並確認該按鍵已啟用啟動不再報告身份驗證失敗
404或協定錯誤base_url 保留 /v1 且 wire_api 等於回應修正使用者配置並完全重新啟動 Codex請求到達回應路由
型號不可用模型來自即時目錄,屬於關鍵組使用當前可存取的標識符而不是舊的螢幕截圖最小任務接收模型回應
配置不變僅視窗關閉、配置層錯誤或剩餘進程儲存使用者級文件,退出所有Codex進程,然後重新啟動活動提供者與新配置相符

常見問題

Codex需要什麼連接到Get API?

Get API 金鑰、https://relay-api.getapi.pro/v1, 目前可存取的模型識別碼以及具有 env_key 和 wire_api =「回應」的自訂提供者。

為什麼真正的金鑰應該遠離 config.toml?

設定檔可能會被同步、備份或意外提交。僅將 GETAPI_PRO_API_KEY 儲存在檔案中,並將實際值保存在受控的本機環境或秘密管理器中。

為什麼CCSwitch Provider變更沒有生效?

正在運行的 Codex 進程可能仍保留舊配置。儲存選擇,退出每個 Codex 進程,重新啟動它,並測試一項最小任務。

這個 Codex 設定可以使用 /chat/completions 代替嗎?

本指南不做這樣的假設。目前的 Codex 自訂提供者合約僅支援回應 wire_api,因此 Get API 回應路由必須可用。

商務合作: business@honeykid.cn