ドキュメント/ 設定

クライアント接続

ほとんどのクライアントでは、エンドポイントを GPT-Load に向け、プロバイダーのキーをAccessKeyに置き換えるだけです。

一般的なルール§

どのクライアントでも、変更するのは次の2項目です:

  • エンドポイント URLhttp://127.0.0.1:3001に変更します。/v1を付けるかどうかはクライアントによって異なるため、以下の例を参照してください。
  • キー — アップストリームプロバイダーのキーではなく、管理画面で作成したAccessKeyを使います。

認証方式はクライアント本来の方式をそのまま使います。ゲートウェイはAuthorization: Bearerx-api-keyx-goog-api-key、Gemini のkeyクエリパラメーターを受け付けます。

モデル名を一致させる必要があります

リクエストするモデルは、このAccessKeyに認可されたGroupで公開されている必要があります。モデルが存在しない場合はGroupの「モデル」タブを確認してください。詳細はGroupとチャネルを参照してください。

管理画面に設定を生成させる§

管理画面ではクライアントごとの接続設定を生成できる。AccessKeyと対象クライアントを選び、生成された設定をコピーしてください。

FIG. 1 — ワンクリックでの構成生成キーとクライアントを選択

Claude Code、Codex、Gemini CLI、Cherry Studio、Cline、NextChat、Open WebUI、CC Switch、New API、curl に対応しています。生成された設定にはそのクライアントが必要とするプロトコルが示されるため、その通りにチェックすれば間違いありません。

OpenAI SDK§

公式 SDK では2か所だけ変更します:

Python
from openai import OpenAI

client = OpenAI(
    base_url="http://127.0.0.1:3001/v1",   # この行を変更
    api_key="あなたのAccessKey",          # この行を変更
)

resp = client.chat.completions.create(
    model="あなたのモデル名",
    messages=[{"role": "user", "content": "こんにちは"}],
)
Node.js
import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "http://127.0.0.1:3001/v1",
  apiKey: "あなたのAccessKey",
});

環境変数を使う場合はOPENAI_BASE_URLOPENAI_API_KEYを設定すれば、コードの変更は不要です。

Anthropic SDK§

Python
from anthropic import Anthropic

client = Anthropic(
    base_url="http://127.0.0.1:3001",   # 注意:/v1 は付けない
    api_key="あなたのAccessKey",
)

Anthropic クライアントは/v1/messagesを使います。SDK がこのパスを付加するため、base_urlにはサーバーのルートを設定します。

Claude Code§

環境変数でゲートウェイを指定します:

ターミナルで設定後に起動
export ANTHROPIC_BASE_URL="http://127.0.0.1:3001"
export ANTHROPIC_AUTH_TOKEN="あなたのAccessKey"

claude

永続化するにはシェルの設定ファイルへ追加します。このAccessKeyではAnthropic Messagesプロトコルを有効にしてください。

Codex CLI§

Codex は OpenAI プロトコルを使います。エンドポイントとキーをゲートウェイへ向けるか、管理画面で生成した Codex 設定をコピーしてください。

環境変数方式
export OPENAI_BASE_URL="http://127.0.0.1:3001/v1"
export OPENAI_API_KEY="あなたのAccessKey"
Codex に必要なのは Responses であり、Chat Completions ではありません

この AccessKey では OpenAI Responses プロトコルにチェックが必要です。Codex は Responses API を使うため、Chat Completions だけを選ぶとリクエストは拒否されます。ルーティングチェックでは protocol_filtered が表示されます。

サブスクリプションアカウントと混同しないでください

ここではCodex クライアントをゲートウェイへ接続する手順を説明しています。Codex のサブスクリプションアカウントをアップストリームとして使う手順は別です。サブスクリプションアカウントを参照してください。

Gemini CLI§

環境変数方式
export GOOGLE_GEMINI_BASE_URL="http://127.0.0.1:3001"
export GEMINI_API_KEY="あなたのAccessKey"

Gemini クライアントは/v1beta/models/…を使います。AccessKeyでGeminiプロトコルを有効にしてください。

デスクトップクライアント§

Cherry Studio、NextChat、Open WebUI、Cline などの GUI クライアントには、通常「カスタム API アドレス」と「API Key」の入力欄があります。次のように設定します:

  • APIアドレスhttp://127.0.0.1:3001/v1
  • API Key:AccessKey
  • モデル:Groupが公開しているモデル名を入力します。一部のクライアントは「モデル一覧を取得」で自動取得できます。

特定クライアントのスクリーンショット手順は、管理画面のワンクリック生成の方が速い——そのクライアントに対応する正確なフィールドが表示されます。

接続できない場合§

次の順序で確認してください。多くの問題は最初の2手順で特定できます:

  1. まず curl でゲートウェイ自体を検証 — ゲートウェイ自体とクライアント設定の問題を切り分けます:
最小検証
curl http://127.0.0.1:3001/v1/chat/completions \
  -H "Authorization: Bearer あなたのAccessKey" \
  -H "Content-Type: application/json" \
  -d '{"model":"あなたのモデル名","messages":[{"role":"user","content":"hi"}]}'
  1. curl は通るがクライアントは通らない — 多くの場合、エンドポイント末尾の/v1が余分または不足しているか、AccessKeyでプロトコルが有効になっていません。
  2. モデルが存在しないことを示す — Groupの「モデル」タブで、そのモデルが公開されていることを確認します。
  3. リクエストは送信されたが失敗した監視とトラブルシュートのリクエストログで具体的な原因を確認します。ルートチェックでは候補Groupと利用可能な認証情報数を確認できます。
クライアント接続 - GPT-Load