API キー管理

API キーは API 呼び出しに使用する認証情報です。キーごとに権限範囲とクォータ上限を設定できます。左側ナビゲーションの「API キー」または /keys から開けます。

API キー一覧には、作成済みの各キーについて、名前、状態、使用済みクォータ、残りクォータ、有効期限などが表示されます。

API キー一覧

API キーを作成

基本設定

作成ダイアログを開く

API キー一覧ページ右上の「API キーを作成」をクリックして、作成ダイアログを開きます

キー名を入力

キーの用途が分かる名前を入力します(例:「本番環境」「テスト用」)

API キーの作成

詳細設定

設定項目説明
有効期限有効期間を設定します。空欄または -1 にすると無期限になります
クォータAPI キーが消費できる最大クォータを制限します。上限を超えると自動的に無効になります
クォータ無制限有効にするとキー単位のクォータ制限を受けません(アカウント全体のクォータは適用されます)
モデル制限指定したモデルのみ呼び出せるよう制限します。空欄の場合は制限しません
IP ホワイトリストこの API キーを利用できる送信元 IP を制限します。空欄の場合は制限しません
グループこの API キーで使用するチャネルグループを指定します

API キーを保存

「変更を保存」をクリックして API キーの作成を完了します。作成したキーは一覧からコピーして利用できます。

作成された API キー

API キーを編集

API キー一覧で対象キーの右側にある「編集」をクリックすると、キー自体を除く設定を変更できます。有効期限、クォータ、モデル制限、IP ホワイトリスト、グループなどを編集できます。

API キーを削除

API キー一覧で対象キーの右側にある「削除」をクリックします。確認後、キーは直ちに無効になり、復元できません。

ℹ️ ベストプラクティス
  • 本番、テスト、開発など、用途ごとに別の API キーを作成します
  • 意図しない過剰消費を防ぐため、各 API キーに適切なクォータ上限を設定します
  • 使用しなくなった API キーを定期的に削除します
  • 本番用 API キーには IP ホワイトリストを設定してセキュリティを高めます