API キー
外部システムからOpenAI 互換 API や MCP を呼び出すための認証キーを発行・管理します。キーごとに、利用できるリソース・利用量・接続元 IP を細かく制限できます。
対象:開発者 / 管理者
補足
このページは「リファレンス」型です。発行手順は短く、各設定項目の意味を一覧で示します。
発行する
[API キー](API Access Key)画面で「発行」を選びます。- 名前と各種制限を設定して作成します。
→
sk-で始まるキーが表示されます。 - リクエストの
Authorization: Bearer <API_KEY>ヘッダに設定します。
注意
キー全体が表示されるのは発行時のみです。安全な場所に保管してください。後から再表示する場合は、所有者または管理者のみが reveal で確認できます。
設定項目
| 項目 | 説明 |
|---|---|
name / description | キーの名称・用途メモ |
bound_assistant_id | このキーを 1 つのアシスタント(Bot)に固定する |
allowed_assistants | 利用を許可するアシスタント |
allowed_vector_stores | 利用を許可するナレッジ(RAG) |
allowed_datasets | 利用を許可するデータセット(SQL) |
allowed_dashboards | 利用を許可するダッシュボード |
monthly_token_limit | 月あたりのトークン上限 |
monthly_request_limit | 月あたりのリクエスト数上限 |
rpm_limit | 1 分あたりのリクエスト数上限(レート制限) |
allowed_ips | 接続を許可する IP / CIDR |
expires_at | 有効期限 |
tool_passthrough | ツール呼び出しの透過を許可するか |
未指定の許可リストは「制限なし(所有者の権限の範囲)」として扱われます。各キーの権限は、所有ユーザーの権限を超えることはできません。
利用状況の確認
発行済みキーは、消費トークン・リクエスト数などの利用状況を確認できます(/v1/api-keys/{id}/usage)。上限に達したキーは自動的に拒否されます。
失効する
不要になったキーは削除(失効)します。削除後は即座に認証できなくなります。退職者・委託先のキーは速やかに失効してください。