API とプレイグラウンド

プレイグラウンド

プレイグラウンドは AI モデルを手軽にオンラインで試すための機能です。質問や指示を入力してモデルと会話し、生成結果を確認できます。入口は左側ナビゲーションの「プレイグラウンド」または /playground です。

グループとモデルを選ぶ: 入力欄の右下で利用可能なモデルグループと具体的なモデルを選び、この会話で使うモデルを決めます。
リクエストパラメーターを設定する: パラメーター設定ボタンをクリックし、必要に応じて温度、Top P、頻度ペナルティ、存在ペナルティ、最大トークン数などの生成パラメーターを有効にして調整します。
会話内容を入力する: 下部の入力欄に質問、指示、プロンプトを入力します。
リクエストを送信する: モデル、パラメーター、入力内容を確認したら「送信」ボタンをクリックします。
応答を確認する: 生成が完了したら会話エリアで応答を確認し、続けて質問を入力してマルチターンの会話を続けられます。

API アドレスと認証

ゲートウェイの OpenAI 互換アドレスは通常次の形式です。

https://your-host/v1

API キーをベアラートークンとして使用します。

Authorization: Bearer sk-your-api-key

チャット補完の例:

curl https://your-host/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-your-api-key" \
  -d '{"model":"gpt-4o-mini","messages":[{"role":"user","content":"こんにちは"}]}'

SDK の例

Python（OpenAI SDK）

from openai import OpenAI

client = OpenAI(
    api_key="sk-xxxxxxxx",
    base_url="https://your-host/v1",
)

response = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "こんにちは"}],
)
print(response.choices[0].message.content)

Claude ネイティブ形式

curl https://your-host/v1/messages \
  -H "x-api-key: sk-xxxxxxxx" \
  -H "anthropic-version: 2023-06-01" \
  -H "content-type: application/json" \
  -d '{"model": "claude-3-5-sonnet-20241022", "max_tokens": 1024, "messages": [{"role": "user", "content": "Hello"}]}'

Gemini ネイティブ形式

curl "https://your-host/v1beta/models/gemini-1.5-pro:generateContent?key=sk-xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"contents": [{"parts": [{"text": "Hello"}]}]}'

対応エンドポイント

会話とテキスト

エンドポイント	パス	説明
チャット補完	`POST /v1/chat/completions`	OpenAI Chat Completions 互換。`model` と `messages` が必要で、ストリーミングと通常応答の両方に対応します。
プレイグラウンドチャット	`POST /pg/chat/completions`	Web プレイグラウンド専用。API キーではなくログインセッションで認証します。課金は通常の呼び出しと同じです。
テキスト補完	`POST /v1/completions`	従来のテキスト補完。`prompt` と `model` が必要です。
Responses API	`POST /v1/responses`	OpenAI Responses 形式。入力、ツール、応答イベントなどに対応します。
Responses の圧縮	`POST /v1/responses/compact`	Responses リクエストのコンテキストを圧縮します。
Claude Messages	`POST /v1/messages`	Anthropic Claude Messages 互換。`model` とメッセージ内容が必要で、必要に応じて上流プロトコルへ変換します。
Codex ウェブ検索	`POST /v1/alpha/search`	Codex 独自のウェブ検索形式。対応しているモデルは一部のみです。
リアルタイム会話	`GET /v1/realtime`（WebSocket）	OpenAI Realtime 形式の双方向通信。モデルは通常クエリパラメーターで渡し、API キーはベアラートークンまたは WebSocket サブプロトコルで渡せます。

ベクトルと並べ替え

エンドポイント	パス	説明
埋め込み	`POST /v1/embeddings`	テキストまたはテキスト配列をベクトルに変換します。`input` が必要です。
Gemini 互換の埋め込み	`POST /v1/engines/{model}/embeddings`	旧来の Gemini 形式の埋め込みパス。URL 内のモデル名で処理します。
リランク	`POST /v1/rerank`	`query` に対して候補の `documents` を関連度順に並べ替えます。クエリとドキュメント一覧は空にできません。
コンテンツモデレーション	`POST /v1/moderations`	テキストなどの入力にモデレーションを実行します。モデル未指定時は既定のモデレーションモデル候補を使用します。

画像と音声

エンドポイント	パス	説明
画像生成	`POST /v1/images/generations`	プロンプトから画像を生成します。指定できるサイズ、品質、枚数は選んだモデルによって決まります。
画像編集	`POST /v1/images/edits`	入力画像とプロンプトから画像を編集します。JSON と `multipart/form-data` に対応します。
旧編集エンドポイント	`POST /v1/edits`	互換性のために残されたパスで、画像リレーに入ります。新しいクライアントは `/v1/images/edits` を推奨します。
音声認識	`POST /v1/audio/transcriptions`	音声をテキストに変換し、OpenAI 音声 API の形式で対応する音声認識チャネルへ転送します。
音声翻訳	`POST /v1/audio/translations`	音声内容を認識し、翻訳したテキストを出力します。
音声合成	`POST /v1/audio/speech`	入力テキストを音声に変換します。

動画や音楽などの非同期生成エンドポイントは、ログと非同期タスクの「非同期生成とタスク API」を参照してください。

モデル一覧

エンドポイント	パス	説明
モデル一覧	`GET /v1/models`	既定では OpenAI 形式のモデル一覧を返します。Anthropic のリクエストヘッダーでは Claude 形式、`x-goog-api-key` または `key` クエリパラメーターでは Gemini 形式を返します。
モデル詳細	`GET /v1/models/{model}`	単一モデルの情報を返します。存在しない場合は `model_not_found` エラーオブジェクトを返します。
Gemini モデル一覧	`GET /v1beta/models`	Gemini 形式で利用可能なモデル一覧を返します。応答フィールドには `models` と `nextPageToken` が含まれます。
OpenAI 形式のモデル一覧	`GET /v1beta/openai/models`	Gemini 互換の名前空間で、OpenAI 形式のモデル一覧を返します。

Gemini ネイティブパス

エンドポイント	パス	説明
Gemini ネイティブ呼び出し	`POST /v1beta/models/{model}:{action}`	Gemini ネイティブ形式。`generateContent`、`streamGenerateContent`、埋め込み関連の操作に対応します。
Gemini 互換呼び出し	`POST /v1/models/{model}:{action}`	`/v1` プレフィックスで Gemini 形式のモデル操作を受け付け、Gemini リレーが解析と変換を担当します。