Skip to Content
ガイド認証APIキー

APIキー

APIキーは、アプリケーションからモデルを呼び出すときの認証情報です。 プロジェクトの中で発行し、利用額もAPIキーごとに集計されるので、アプリケーションや環境ごとに分けておくと、それぞれの費用と上限を別々に管理できます。

プロジェクトに参加している人は、ロールにかかわらず、そのプロジェクトのすべてのAPIキーを操作できます。

リクエストにAPIキーを指定する方法は、APIリファレンスの認証を参照してください。

APIキーを発行する

コンソールでプロジェクトを開き、名前、ルール、有効期限を設定してAPIキーを発行します。

APIキーの値は、発行したときと再生成したときにしか表示されないので、すぐにコピーして環境変数などに保存してください。 ソースコードや公開リポジトリには書き込まないでください。

有効期限のデフォルトは30日で、期限を過ぎたAPIキーでリクエストを送ると 401(invalid_api_key)が返ります。 使い続ける場合は、期限が切れる前に管理APIのAPIキーの設定変更で延ばすか、新しいAPIキーに差し替えてください。

管理APIでもAPIキーを発行、取得、再生成できます。 詳しくはAPIリファレンスのAPIキーの発行を参照してください。

APIキーごとの制限を設定する

使える金額やモデルは、APIキーごとに絞れます。

分類設定できること参照するページ
利用制限予算、1分あたりのリクエスト数とトークン数の上限利用制限
モデル利用できるモデル、auto で試すモデルと順序、フォールバックするモデルモデル、モデルの自動選択、フォールバック
ガードレール個人情報のマスクと、プロンプトインジェクションの検出ガードレール

複数のAPIキーに同じ設定を適用する場合は、ルールを使います。 ルールで設定した項目は、APIキーでは変更できません。

APIキーを再生成する

再生成すると、設定と有効期限はそのままで、APIキーの値だけが新しくなります。 値が漏えいした疑いがあるときに使う操作です。

新しい値は再生成したときに表示され、以前の値はその時点で使えなくなります。 そのため、アプリケーションに設定している値を差し替えるまでは、リクエストが失敗する点に注意してください。

アプリケーションを止めずに差し替える

止めずに差し替える場合は、再生成せずに、次の順で新しいAPIキーへ移します。

  1. 同じプロジェクトで、同じ設定の新しいAPIキーを発行します。
  2. アプリケーションに設定しているAPIキーを、新しいものに差し替えます。
  3. リクエストが成功することを確認します。
  4. 古いAPIキーからのリクエストがないことを、使用状況で確認します。
  5. 古いAPIキーを削除します。

APIキーの無効化と削除

一時的に止めるときは無効に、使わなくなったら削除します。 無効にしたAPIキーは有効に戻せますが、削除したAPIキーは戻せません。

APIキーを発行したメンバーが組織から外れても、APIキーは有効なままなので、不要なものは無効にするか削除してください。

APIキーが漏えいした場合

  1. APIキーを再生成します。漏えいした値は使えなくなります。
  2. 表示された新しい値を、アプリケーションに設定します。
  3. 使用状況で、意図しない利用がないかを確認します。