DigitalBase Docs

APIアクセスキー

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

対象:開発者 / 管理者

発行する

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

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

設定項目

項目説明
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_limit1 分あたりのリクエスト数上限（レート制限）
allowed_ips接続を許可する IP / CIDR
expires_at有効期限
tool_passthroughツール呼び出しの透過を許可するか

未指定の許可リストは「制限なし（所有者の権限の範囲）」として扱われます。各キーの権限は、所有ユーザーの権限を超えることはできません。

Sandbox で疎通確認する

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

利用状況の確認

発行済みキーは、消費トークン・リクエスト数などの利用状況を確認できます（/v1/api-keys/{id}/usage）。上限に達したキーは自動的に拒否されます。

失効する

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

BI キー（データ egress）

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

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

利用方法は 2 通りです。

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

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

関連