利用ガイドAPIリファレンスAIアプリケーション

🔑 API キー

API キーは API を呼び出すためのコア認証情報です。各キーのクォータ、モデル、グループ、および安全な送信元制限を作成および管理します。

左側のナビゲーションで「API キー」をクリックするか、直接 /keys にアクセスします。ページにはキー名、マスクされたキー、有効化ステータス、クォータ使用状況の進捗、バインドされたグループが明確に表示され、キーワード検索、コピー、編集、有効化/無効化、および一括管理をサポートしています。行操作メニューでは、接続構成を直接コピーしたり、ワンクリックで認証情報をサポートされているデスクトップチャットクライアントに送信したりすることもできます。

API キーの作成

  1. 「API キー」管理ページを開き、「API キーを作成」ボタンをクリックします。
  2. 識別しやすいキー名を入力します(例:「Cursor 開発環境」、「本番サービス」など)。
  3. 必要に応じて、呼び出しクォータ、有効期限、モデルホワイトリスト制限、IP ホワイトリスト、およびグループを設定します。
  4. 送信をクリックすると、システムが完全な API キーを生成し、コピーして保存できるようになります。

設定項目の詳細説明

設定項目詳細な役割
名前カスタム名。請求書の区分や統計を取りやすくするため、使用シーンやアプリケーションに応じた命名を推奨します。
グループこのキーがアクセスするチャネルグループを指定します(デフォルトグループ、高速グループ、特定のサブスクリプショングループなど)。
Auto グループ順序グループで auto を選択した場合にのみ有効です。システムのデフォルトのルーティング順序を継承することも、このキー専用の優先順位をカスタマイズすることもできます。
クロスグループ再試行スイッチ有効にすると、優先グループチャネルで障害や制限が発生した場合、自動的かつシームレスに次の候補グループにクロスグループで再試行し、呼び出しの高可用性を確保します。
有効期限キーの失効日時を設定します。期限が切れると自動的に以降のリクエストが拒否されます。空白の場合は無期限になります。
数量複数のキーを一度に一括作成することをサポートします(システムが自動的にランダムなサフィックスを付加します)。
クォータこのキーに独立した消費上限を割り当て、単一のキーがアカウントのメイン残高を過剰に消費するのを防ぎます。
無制限クォータスイッチ有効にすると独立したクォータ制限を受けなくなります(ただし、アカウント全体の残高の制約は引き続き受けます)。
モデル制限このキーが指定されたモデルホワイトリストのみを呼び出せるように制限し、高価なモデルの誤呼び出しを防止します。
IP ホワイトリストリクエストの発行を許可する IPv4/IPv6 または CIDR ネットワークセグメントを1行ずつ入力します。空白の場合は送信元を制限しません。

API キーはアカウントの認証情報と同等です。キーを平文のままパブリックな GitHub リポジトリ、フロントエンドクライアントコード、またはパブリックチャットツールにコミット/送信しないでください。漏洩が疑われる場合は、直ちに削除して新しいキーを生成してください。

API キーの表示とコピー

API キー一覧でマスクされたキーをクリックし、プロンプトに従ってセキュリティ認証を完了すると、完全なキーをコピーできます。

「接続情報をコピー」をクリックすると、Base URL と API Key を標準のクライアント接続文字列としてワンクリックで組み合わせることができます。また、対象のチャットクライアントのアイコンをクリックして、ブラウザプロトコル経由でローカルクライアントをワンクリックで起動し、設定を自動入力することもできます。

API キーの編集

一覧で対象のキーを見つけ、「編集」ボタンをクリックすると、クォータ上限、モデルホワイトリスト、有効期限、または IP 制限をいつでも調整できます(設定を変更しても API Key 自体は変更されません)。

有効化、無効化、および削除

  • 有効化 / 無効化:呼び出し権限を一時的に停止します。設定は保持され、再度有効化すると呼び出しを再開できます。
  • 削除:このキー認証情報を完全に破棄します。削除操作は復元できませんので、実行中のサービスが依存していないことを確認してから削除を実行してください。

このドキュメントは役に立ちましたか?

🔑 API キー | OpenRely Docs