Gateway の API キー
Gateway のキーは 1 つのワークスペースに属し、作成時に一度だけ表示されます。部門への費用計上、モデル・アドレス・有効期限による制限、重複期間付きのローテーション、取り消しができます。
キーを作成する#
ワークスペースのオーナーと管理者は、AI Gateway › はじめに でキーを管理します。API キーを作成 を選び、使うチームやツールの名前などを付けて、キーをコピーします。キーは一度しか表示されず、ハッシュとしてのみ保存されます。なくした場合は、新しいキーを作成してください。
キーは al_gw_<id>.<secret> の形式です。Authorization: Bearer <key> として送ります。/v1/chat/completions 以外のエンドポイントでは x-api-key としても送れます。キーで呼び出せるのは Gateway の /v1 エンドポイントだけで、コンソールや他の Agent Lab 製品は呼び出せません。
キーをブラウザに置かないでください
Gateway は Origin ヘッダーを含むリクエストを拒否します（server_application_required）。サーバー、CLI、スクリプトから呼び出し、キーは環境変数かシークレットストアに保管してください。
キーの費用を部門に計上する#
キーの 費用の帰属 で、そのキーの支出をどの予算に計上するかが決まります。部門を選ばなければ、支出はワークスペースにだけ計上されます。1 つ以上選ぶと、そのキーで行ったすべてのリクエストが、選んだ各部門の上限にもそれぞれ全額計上されます。変更は次のリクエストから反映され、記録済みの支出は移動しません。
キーでできることを制限する#
いずれも任意で、新しいキーには何も設定されていません。
| 制御 | 内容 |
|---|---|
| 有効期限 | この時刻を過ぎると、キーは取り消されたものとして扱われます。期限が近いキーから順に、残り日数とともに一覧されます。 |
| 許可するモデル | 他のモデルを指定したリクエストは gateway_key_model_not_allowed で拒否されます。auto は一覧のモデルからだけ選びます。 |
| 許可するアドレス | 最大 32 個の IP 範囲（CIDR）。それ以外のアドレスからのリクエストは無効なキーとして拒否され、その拒否はアドレスとともに記録されます。 |
| レート制限 | このキーの 1 分あたりのリクエスト数とトークン数。レート制限を参照。 |
| 同時実行数の上限 | 同時に処理中にできるリクエストの最大数。既定では設定されておらず、プロバイダーに直接接続したときと同じく並列のリクエストを受け付けます。 |
キーをローテーションする#
ローテーション を選ぶと、同じ部門、許可リスト、制限を持つ新しいキーが作成され、古いキーには選んだ重複期間（たとえば 7 日間）のあとに切れる有効期限が付きます。重複期間中は両方のキーが使えるので、途切れることなく各ツールを新しいキーに移せます。新しいキーは一度だけ表示されます。
キーを取り消す#
取り消す を選ぶと、キーはすぐに停止します。そのキーを使った次のリクエストは application_key_not_accepted で拒否され、すでに実行中のリクエストは最後まで処理されます。取り消したキーは元に戻せません。
最終使用日時#
キーの一覧には、各キーが最後にモデルへリクエストを送った日時が表示されます。リクエストを送らずにキーを確認しただけでは数えられません。
コードからキーを管理する#
プラットフォームチームは、ワークスペース管理者のトークンを使って /v1/gateway/keys からキーを作成、一覧、取り消しできます。たとえば開発者ごとに専用のキーを配る場合に使えます。これらの呼び出しはコンソールと同じ監査イベント（gateway.api_key_created、gateway.api_key_revoked）を、チャネルを API として記録します。シークレットは作成呼び出しの応答で一度だけ返されます。