APIアクセスキー

外部システムからOpenAI 互換 API や MCP を呼び出すための認証キーを発行・管理します。キーごとに、利用できるリソース・利用量・接続元 IP を細かく制限できます。

対象:開発者 / 管理者

発行する

[API キー]（API Access Key）画面で「発行」を選びます。
名前と各種制限を設定して作成します。 → sk- で始まるキーが表示されます。
リクエストの Authorization: Bearer <API_KEY> ヘッダに設定します。

注意

キー全体が表示されるのは発行時のみです。安全な場所に保管してください。後から再表示（reveal）できるのは発行した本人だけです。管理者（ADMIN）を含め、他ユーザーのキーは誰も閲覧・再表示できません。

設定項目

項目	説明
`name` / `description`	キーの名称・用途メモ
`bound_assistant_id`	このキーを 1 つのアシスタント（Bot）に固定する
`allowed_assistants`	利用を許可するアシスタント
`allowed_vector_stores`	利用を許可するナレッジ（RAG）
`allowed_datasets`	利用を許可するデータセット（SQL）
`monthly_token_limit`	月あたりのトークン上限
`monthly_request_limit`	月あたりのリクエスト数上限
`rpm_limit`	1 分あたりのリクエスト数上限（レート制限）
`allowed_ips`	接続を許可する IP / CIDR
`expires_at`	有効期限
`tool_passthrough`	ツール呼び出しの透過を許可するか
ツール権限上限（`maxLevel`）	このキー経由で提示するツールの上限。`読み取りのみ` / `書込まで` / `全自動`（既定）

未指定（または空 []）の許可リストは「制限なし（所有者の権限の範囲）」として扱われます。各キーの権限は、所有ユーザーの権限を超えることはできません。アシスタントに紐づくキーでは、allowed_vector_stores / allowed_datasets はそのアシスタントのスコープとの共通部分に絞られます（キーで広げることはできません）。

ツール権限上限

API キーや MCP 経由の呼び出しには、チャットのような都度承認の画面がありません。そのため、キーに設定した権限上限が承認の代わりになります。

設定	提示されるツール
読み取りのみ	検索・参照系のみ（外部クライアントに渡すキーの推奨値）
書込まで	ファイルの作成・編集まで。コード実行系は提示しない
全自動	コード実行・外部副作用を含むすべて（既定）

上限で外れたツールは一覧に出ないだけでなく、クライアントが名前を指定して呼び出しても実行されません。

Sandbox で疎通確認する

キー一覧の下の Sandbox で、発行したキーをその場でテストできます。キーを選んでプロンプトを送るだけで、応答・所要時間・消費トークンを確認できます。

画面上部の [API リファレンス] を選ぶと、組み込みの API リファレンスが別タブで開きます。

利用状況の確認

[API キー] 画面には、発行済みキーの利用状況がダッシュボードとして表示されます。

KPI: 期間内のリクエスト数（エラー・429 の内訳つき）・トークン（入力 / 出力）・キー数・期限切れ間近のキー
チャート: 日次のリクエスト数（成功 / 失敗）とトークン（入力 / 出力）
内訳: モデル別・キー別のトークン上位。キー名を選ぶと、そのキーの直近 50 件の明細（時刻・モデル・トークン・レイテンシ・成否）が開きます
集計期間（直近 7 / 30 / 90 日・今月・直近 1 年）は右上で切り替えられ、次回表示時も選択が保持されます
「CSVエクスポート」で表示中の集計をそのまま取り出せます

モデル別単価を設定している場合は、金額換算も表示されます。上限（monthly_token_limit 等）に達したキーは自動的に拒否されます。

リクエストログ

ヘッダの [ログ] から、リクエスト単位のログを検索できます（期間 × キー × モデル × 成否で絞り込み）。記録はメタデータのみで、プロンプト・回答の本文は保存されません。保持期間などの計測仕様は監視と利用計測を参照してください。

利用量集計 API

管理画面と同じ計測データを、期間 × キー × モデル × チャネル × 日/月 の粒度で機械集計として取得できます。データセンター事業者・再販事業者が、自社の請求システムや課金ダッシュボードを DigitalBase の上に構築するための口です（トークン単価の掛け算・請求書化は呼び出し側で行います）。

# 請求データの元（省略時は当月1日〜現在 = 月次請求の既定窓）
curl -H "Authorization: Bearer sk-..." \
  "https://<host>/v1/api-keys/usage/summary?start=2026-08-01&end=2026-08-31&group=day&format=json"

パラメータ	値	意味
`start` / `end`	`YYYY-MM-DD`	集計期間（end は当日を含む）。省略時は当月1日〜現在
`group`	`day` / `month`	集計粒度
`format`	`json` / `csv`	`csv` は表計算・請求システムへの直接取込用

返却は requests / input_tokens / output_tokens をモデル別・チャネル別（chat / embed / query / mcp 等）に持ちます。admin は全キー（削除済みキーの残存利用分も含む）、一般ユーザーは自分のキーのみが対象です。

失効する

不要になったキーは削除（失効）します。削除後は即座に認証できなくなります。退職者・委託先のキーは速やかに失効してください。

削除したキーの利用実績（リクエスト・トークン）は消えず、利用量集計 API と管理者の利用状況画面には引き続き含まれます（請求・監査の集計がずれないようにするため）。一覧には表示されません。

BI キー（データ egress）

BI ツールやダッシュボードにデータを参照させるための、読み取り専用キーです。チャット／エージェント用の sk- キーとは別系統で、bk- で始まります。

BI キー画面で発行します（allowed_datasets で参照できるデータセットを限定。未指定なら所有者の全データセット）。
発行時にキー全体が表示されます（以降は発行した本人のみ reveal で再表示できます。管理者も他ユーザーのキーは再表示できません）。スキーマやビューを更新したら publish で再同期します。

利用方法は 2 通りです。

方式	接続	内容
REST	`Authorization: Bearer bk-...`	`GET /v1/data/datasets`（一覧）・`/schema`（列）・`POST /v1/data/query`（SELECT のみ実行）
PostgreSQL 互換	`bk-...` をパスワードに直接接続	Looker Studio / Metabase などの BI ツールから、所有者のデータセット（ビュー）へ直接クエリ

いずれも読み取り専用で、許可したデータセットの範囲に限定されます。