API Keys の管理

管理者は API Keys 画面で全メンバーのキーを確認・管理し、メンバーに代わって新規作成したり、既存のキーの制限を調整したりできます。メンバー自身がキーを作成・利用する方法については API Keys をご覧ください。

API Key を探す

一覧には、権限の範囲内にあるすべての API Key が表形式で表示されます。左上で項目を選んでキーワードを入力すると検索でき、右上のフィルターから条件を指定して範囲を絞り込めます。下部では 1 ページあたりの行数を調整し、ページを切り替えられます。

メンバーに代わって新規作成する

右上の New をクリックし、メンバーを選択して名前を入力すると作成できます。

項目	入力方法
Department	任意。選択すると、メンバー一覧にはその部署の人員のみが表示されます
Member	必須。キーの所有者となるメンバーで、呼び出しで発生した費用はこのメンバーに計上されます
Name	必須。キーの用途を区別するために使います

制限をかける必要がある場合は Advanced settings を開きます。クォータ、有効期限、グループ料金、利用可能なモデルの意味はメンバー側と同じで、空欄の場合はそれぞれクォータ無制限、有効期限なし、そのメンバーのグループ料金を使用、利用可能なすべてのモデルを呼び出し可能、となります。

og-auto などの仮想モデルを使う場合

利用可能なモデルを制限したキーは、インテリジェントルーティングによる書き換え後の実際のモデルで検証されます。仮想モデル名だけを選択しても意味がありません。使われる可能性のあるすべての対象モデルと候補モデルを利用可能なモデルに追加しないと、リクエストは 403 を返し、候補モデルへの切り替えも発生しません。対象モデルと候補モデルは、インテリジェントルーティングのルールに従います。

作成後、キーは一覧でマスク表示されます。完全なキーをメンバーに渡す際は、安全な経路で伝えてください。

既存の API Key を調整する

一覧の名前をクリックして詳細画面を開き、変更後に右上の Update をクリックします。不要になった場合は Delete をクリックします。

領域	変更できる内容
基本情報	名前とグループ料金は変更できます。部署、ユーザー、ステータス、キー、作成日時はシステムが管理します
クォータと有効期限	Unlimited にチェックを入れるか、具体的なクォータを入力します。有効期限を設定でき、Never、1 hour、1 day、1 month のショートカットも使えます
アクセス制限	Available models を調整します。IP restrictions には、アクセスを許可するアドレスを 1 行に 1 つずつ入力します。空欄の場合は制限なしです

削除はメンバーの呼び出しに影響します

削除は元に戻せず、そのキーを使用しているアプリケーションに影響します。漏えいや退職によりアクセスを取り消す場合は、まず無効化して同期結果を確認してください。セマンティックキャッシュを有効にしている場合は、キャッシュヒット時と上流への転送経路の両方も検証する必要があります。アクセス停止の確認手順をご覧ください。グループ料金や利用可能なモデルの変更も稼働中のアプリケーションに影響するため、変更前に利用者と確認してください。

メンバーから呼び出しの異常が報告されたとき

症状	確認ポイント
キーが無効と表示される	キーが削除されていないか、メンバーが最新のキーを使っているかを確認します
クォータ不足と表示される	一覧で残りクォータを確認します。キーのクォータを使い切った場合はクォータを引き上げます。メンバーのアカウントのクォータを使い切った場合は、クォータと引き換えコードで補充します
キーの有効期限切れと表示される	詳細画面で有効期限を設定し直します
モデルが存在しない、または権限がないと表示される	詳細画面の利用可能なモデルと、そのモデルを提供するプロバイダーでキーが使用するグループ料金が選択されているかを確認します。グループ料金をご覧ください
一部のマシンでは呼び出せるが、一部では呼び出せない	詳細画面の IP 制限に、それらのマシンの送信元アドレスが含まれているかを確認します
ステータスが期限切れまたは使い切り	これらのステータスのキーは、有効期限を延長するかクォータを補充しないと呼び出しを再開できません

特定の呼び出しを確認する必要がある場合は、リクエストログでユーザーと API Key で絞り込みます。