Get API

GET API · 開発者向け連携ガイド

デスクトップおよび CLI で Codex を Get API に接続します。

Codex CLI は現在、サポートされている唯一のワイヤー値である base_url、env_key、および wire_api = "responses" を持つカスタム モデル プロバイダーをサポートしています。 Get API Codex 構成では、https://relay-api.getapi.pro/v1 と同じサイトのコンソールからのキーを使用します。現在のカタログからモデルを選択します。検証されたデスクトップ フローでは、CCSwitch を使用してプロバイダーを選択し、その後、完全な Codex を再起動できます。

最初に Codex と Responses コントラクトを確認します

現在の Codex 構成リファレンスはカスタム プロバイダーをサポートし、応答を唯一の wire_api 値としてリストします。 Get API は /v1/responses ルートも登録するため、このガイドではチャット エンドポイントを代替証拠として扱うのではなく、応答構成を使用します。

  • 構成前に codex --version を実行します
  • プロバイダー設定をユーザーレベルの config.toml に配置します。
  • 現在の Get API カタログからモデルを選択してください

キー、アドレス、モデルを 1 つの構成に保持

キーは getapi.pro コンソールから取得され、Base URL は relay-api.getapi.pro を使用し、モデルはそのキーで現在利用可能な識別子である必要があります。別のサービスや古いスクリーンショットを混在させると、認証やルーティングの失敗が発生する可能性があります。

  • 環境変数名を env_key と一致させます。
  • ベース URL に /v1 を保持します。
  • config.toml には実際のキーを決して置かないでください。

切り替え後に再起動し、合否チェックを使用する

実行中のクライアントは、CCSwitch やファイルの変更をリロードできない場合があります。 Codex を完全に終了し、再度開き、プロジェクト コンテキストに依存しない単純なタスクを送信し、失敗した場合は実際のプロバイダー、モデル、ステータスを検査します。

  • 実行中のすべての Codex プロセスを終了します
  • 最初に最小限のタスクを 1 つ使用する
  • ブラインド再試行の代わりに HTTP 状態を記録する

Codex プロバイダーを構成する

CCSwitch デスクトップ パスと CLI パスは、同じ Get API キーとベース URL を共有します。

  1. 現在の公式エントリからCodexをインストールして確認してください

    現在の公式 Codex インストール ページでオペレーティング システムに応じた方法を選択し、codex --version を実行してコマンドを確認します。

  2. Codex の Get API キーを作成します。

    メインサイトのコンソールでキーを作成し、ターゲット モデルに到達する現在のグループを選択し、カタログから使用可能なモデル ID をコピーします。

  3. 環境変数とユーザー構成を設定する

    実際のキーを GETAPI_PRO_API_KEY として保存し、以下のプロバイダーをユーザーレベルの config.toml に追加します。資格情報をプロジェクトにコミットしないでください。

  4. CCSwitch で Codex を選択します

    デスクトップ パスについては、CCSwitch の Codex プロバイダー領域を開き、Get API 構成が有効になっていることを確認します。

    Codex CCSwitch のプロバイダー セレクター
    プロバイダーを管理する前に、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 プロバイダーの変更が有効にならないのはなぜですか?

実行中の Codex プロセスは古い構成を保持している可能性があります。選択内容を保存し、すべての Codex プロセスを終了し、再起動して、最小タスクを 1 つテストします。

この Codex セットアップでは、代わりに /chat/completions を使用できますか?

このガイドはそれを前提としていません。現在の Codex カスタム プロバイダー コントラクトは、応答 wire_api のみをサポートしているため、Get API 応答ルートが使用可能である必要があります。

ビジネスに関するお問い合わせ: business@honeykid.cn