コンテンツへスキップ
API プレイグラウンド

API プレイグラウンド

インタラクティブ

すべてのモデルとエンドポイントを、お持ちのキーを使ってブラウザで試せます。ストリーミング出力、リクエストインスペクタ、そのままアプリに貼り付けられる生成コードを備えています。

プレイグラウンドを起動

プレイグラウンドは、/docs/playground にある API 向けのチャットコンソールです。モデルと会話すると、プレイグラウンドは、お使いのコードが送るのと同じリクエストを、設定したモデル、システムプロンプト、パラメータ、ツールとともに、三つのエンドポイントのいずれかに送信します。どのリクエストも、コードと生のストリームイベントとして読み返せます。

はじめに

  • キーを設定する — サインインしている場合、プレイグラウンドはアカウントの API キーを使い、残高を表示します。サインインしていない場合は、キーを追加 を選択してキーを貼り付けてください。キーはこのタブにのみ保持され、保存されることはありません。
  • エンドポイントとモデルを選ぶ — 上部のバーに、エンドポイントの切り替えとモデルピッカーがあります。新しい会話は、Chat Completions と shannon-3 で始まります。
  • メッセージを送信する — 下に入力して Enter を押します。応答はすべて会話に加わるため、次のメッセージで会話を続けられます。空の画面には、三つのスタータープロンプトと、すぐ使えるツール呼び出しの例があります。

キーの確認とローテーションは、キーと使用量のページで行えます。 キーと使用量

エンドポイントとモデル

エンドポイントの切り替えが、プレイグラウンドが作成するリクエスト形式を決めます。会話の途中でも変更でき、メッセージはそのまま残ります。

エンドポイント 送信するリクエスト リファレンス
Chat Completions POST /v1/chat/completions Chat Completions
Responses POST /v1/responses Responses API
Messages POST /v1/messages Anthropic 形式

モデルピッカーには、GET /v1/models が返す内容が一覧表示されます。検索でき、最近使ったモデルが上部に表示され、各モデルについて、1M トークンあたりの価格、コンテキストウィンドウ、ツール・画像入力・推論・構造化出力の印が表示されます。

会話

  • 応答は、書かれるそばからスレッドにストリームされます。モデルの推論は専用のブロックに表示され、折りたたむことができます。
  • 各応答の下に表示されるもの:最初のトークンまでの時間、毎秒のトークン数、経過時間、キャッシュ済みと推論の内訳を含む入力・出力トークン、ターンのコストの推定、終了理由、レスポンス ID。
  • 自分のメッセージは、その時点から編集して再送信できます。応答は再生成できます。メッセージは削除でき、削除は数秒間、元に戻せます。
  • 停止 または Esc キーで、書き込み中の応答を終了します。
  • 画像は、画像に対応するモデルで、画像ボタン、貼り付け、またはファイルのドロップによって添付します。画像は、送信前に長辺 1,568 ピクセルに縮小されます。30 MB を超えるファイルはスキップされます。
  • コンポーザーとシステムプロンプトには、トークン数が表示されます。ホスト型オープンウェイトモデルでは POST /v1/tokenize による正確な数です。その他のモデルでは推定値で、≈ が付きます。
  • 失敗したリクエストには、次にすべきことが表示されます。キーが拒否された場合はキーの設定、残高を使い切った場合はチャージ、リクエストが多すぎた場合は待つ秒数、サーバーエラーの後は再試行です。

リクエスト設定

設定 ボタンで、六つのタブがあるパネルが開きます。設定は会話ごとに保持され、各会話がそれぞれの設定を持ちます。

タブ 保持する内容
システム 会話のシステムプロンプト。すべてのリクエストとともに送信されます。五つのテンプレートで入力でき、トークン数も表示されます。
パラメータ 最大出力トークン、temperature、top_p、推論 effort、停止シーケンス、seed、およびストリーミングとウェブ検索のスイッチ。選択したエンドポイントにフィールドがないコントロールは、オフになり、印が付きます。
ツール リクエストとともに送信するツール定義:四つのプリセット(get_weather、read_file、run_shell、web_search)、または JSON で書いた独自の定義、そして tool_choice(auto、none、required、または名前で指定したツールひとつ)。モデルがツールを呼び出すと、スレッドに、結果を入力するボックス付きで呼び出しが表示されます。サンプル結果を提示 をオンにすると、ワンクリックでサンプル結果が入力されます。独自の結果を入力して送信し、ターンを続けることもできます。
構造化 response_format:text、json_object、またはスキーマ名と JSON スキーマを持つ json_schema。スキーマを設定すると、最後の回答がそれに照らして確認され、スレッド内で一致または不一致の印が付きます。Messages エンドポイントではこのタブはオフになり、選択したモデルが受け付けないオプションは表示されません。
コード 現在の会話のリクエストを、会話と設定から作成した cURL、Python、Node、Go のコードとして表示します。キーは YOUR_API_KEY と表示されます。コードはコピーしたり、大きな表示で開いたりできます。
イベント 直近のターンの通信内容:時間オフセット付きのすべてのストリームイベントとフィルタ、組み立てられた応答、応答ヘッダー(x-request-id、content-type、retry-after、date)、リクエストボディ。これらはページを再読み込みするまで保持されます。

入力チェック

入力した値は、リクエストを送信する前に確認されます。範囲外の値はそのフィールドに表示され、修正されるまで送信が保留されます。

設定 確認内容
最大出力トークン 1 からモデルの max_output_tokens までの整数。
Temperature 0〜2 の数値。空の場合、そのフィールドはリクエストに含まれません。
top_p 0〜1 の数値。空の場合、そのフィールドはリクエストに含まれません。
seed 整数。
停止シーケンス カンマ区切りで最大 4 個。
response_format 選択したモデルが受け付けるものでなければなりません。json_schema や response_format のないモデルに切り替えた会話は、理由が示されたうえで送信が保留されます。
画像 テキストのみのモデルに切り替えると、メッセージから削除され、通知が表示されます。

二つのモデルを比較

その他 メニューの 二つのモデルを比較 で、二つ目のモデルピッカーが追加されます。以降、各メッセージは同じ設定で両方のモデルに同時に送信され、二つの回答が A と B の印付きで並んで表示されます。片側だけを再生成することもできます。片側がツールを呼び出した場合、送信した結果はその側だけで続行されます。

共有、エクスポート、インポート

  • 共有リンクをコピー は、会話をリンク自体の # 以降の部分にまとめます。何もアップロードされません。画像、キー、直近の実行の詳細は含まれません。リンクを開いた人は、自分のプレイグラウンドで、その会話を新しい会話として受け取ります。
  • リンクにするには長すぎる会話は、通知とともに拒否されます。代わりに JSON としてダウンロードしてください。
  • 会話の JSON をダウンロード は、会話を設定とともにファイルとして保存します。会話パネルの JSON をインポート で、そのようなファイルを開けます。
  • cURL としてコピー は、現在のリクエストを cURL コマンドひとつとしてコピーします。

何がどこに保存されるか

内容 保存場所
会話、保存したツール、最近使ったモデル、パネルのレイアウト このブラウザ内。Shannon には送信されず、別のデバイスにも引き継がれません。
API キー 開いているタブのメモリ内。貼り付けたキーは、ページを再読み込みするかタブを閉じると消えます。サインインしている場合は、そのつどアカウントからキーが読み取られます。
直近のターンのストリームイベント、ヘッダー、リクエスト 開いているページ内。再読み込みするまで保持されます。
リクエスト お使いのブラウザから、キーを付けて API に送信されます。他の API リクエストと同様に、残高から差し引かれます。

キーボード

キー 動作
Enter メッセージを送信します。
Shift + Enter 改行します。
Ctrl + K コマンドパレットを開きます:エンドポイントまたはモデルの切り替え、システムテンプレートの設定、新しい会話の開始、ストリーミング・ツール・比較の切り替え。Mac では ⌘ K。
Esc 書き込み中の応答を停止します。狭い画面では、開いているパネルを閉じます。

プレイグラウンドを起動