DigitalBase Docs

APIアクセスキー

外部システムから OpenAI 互換 API / MCP を呼び出すための認証キー。キーごとに利用可能なリソース・利用量・接続元 IP を制限できる。

対象:開発者 / 管理者

発行する

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

発行時にキー全体を表示。あとから一覧の目のアイコンで再表示できるのは発行した本人のみ（管理者も他ユーザーのキーは閲覧不可。再表示は監査ログに残る）。

設定項目

項目説明
name / descriptionキーの名称・用途メモ
bound_assistant_idこのキーを 1 つのアシスタント（Bot）に固定する
allowed_assistants利用を許可するアシスタント
allowed_vector_stores利用を許可するナレッジ（RAG）
allowed_datasets利用を許可するデータセット（SQL）
monthly_token_limit月あたりのトークン上限
monthly_request_limit月あたりのリクエスト数上限
rpm_limit1 分あたりのリクエスト数上限（レート制限）
allowed_ips接続を許可する IP / CIDR
expires_at有効期限
tool_passthroughツール呼び出しの透過を許可するか
file_access手元の PC から自分の myfile をネットワークドライブとしてつなぐ時のパスワードに使えるか（PC と接続）
file_rootそのキーで見せる myfile の中のフォルダ（ドライブの一番上になる）。null = myfile 全体。指定するとツールの個人フォルダもその中だけになり、シェルは出さない
ツール権限上限（maxLevel）このキー経由で提示するツールの上限。読み取りのみ / 書込まで / 全自動（既定）
  • 許可リストは未指定（null）なら制限なし。空の配列（[]）は何も許可しない。
  • キーの権限は所有ユーザー・紐づくアシスタントの範囲を超えない。

ツール権限上限

API キー / MCP 経由では都度承認がない。キーの上限が承認の代わりになる。

設定提示されるツール
読み取りのみ検索・参照系のみ（外部クライアントに渡すキーの推奨値）
書込までファイルの作成・編集まで。コード実行系は提示しない
全自動コード実行・外部副作用を含むすべて（既定）
  • 上限外のツールは一覧に出ず、呼び出しても実行しない。
  • ツールはアシスタントを紐づけたキーだけに出る。紐づけていないキー・PC と接続のキーはツールなし。
  • アシスタントの範囲では、キーの持ち主の個人フォルダ（ファイル操作とシェル）を既定で提示し、承認なしで実行する。アシスタントの設定で外せる。

Sandbox で疎通確認する

キー一覧の下の Sandbox で確認する。

  1. キーを選ぶ。
  2. プロンプトを送る。
  3. 応答・所要時間・トークンを確認する。

画面上部の [API リファレンス] で組み込み API リファレンスを開く。

利用状況の確認

[API キー] 画面に、リクエスト数・トークン・モデル別 / キー別の内訳を期間指定で表示する。「CSVエクスポート」で出力する。

  • 画面のチャットの利用は「画面 (チャット)」として並ぶ。自分の分だけで、管理者は全員分。
  • 実際に答えた接続先（この機・別ホストの推論サーバー・クラウド）別の内訳も表示する。ログと CSV にも残る。
  • モデル別単価を設定すると金額も表示する。
  • 上限に達したキーは自動で拒否する。

リクエストログ

ヘッダの [ログ] でリクエスト単位のログを検索する。記録はメタデータのみ（本文は保存しない）。保持期間は監視と利用計測。

利用量集計 API

計測データを 期間 × キー × モデル × チャネル × 日/月 で取得する。請求システム連携用で、単価計算は呼び出し側で行う。

請求データの元を取得する。省略時は当月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 / endYYYY-MM-DD集計期間（end は当日を含む）。省略時は当月1日〜現在
groupday / month集計粒度
formatjson / csvcsv は表計算・請求システムへの直接取込用

返却は requests / input_tokens / output_tokens。admin は全キー、一般ユーザーは自分のキーのみ。

失効する

不要なキーは削除する。即座に認証不可になる。利用実績は利用量集計 API に残る。

BI キー（データ egress）

BI ツール・外部システムとのデータ連携用のキー（bk- で始まる）。BI キー画面で発行する。

  • allowed_datasets で参照先を限定する。未指定なら所有者の全データセット。
  • 既定は参照のみ。データセットごとに 追加・更新・削除 を付けると、そのデータセットには REST / PostgreSQL 互換の接続から書き込める。
  • 付けたもの以外は 403。Parquet 形式のデータセットは書き込み不可。
  • スキーマ・ビューの更新後は publish で再同期する。
  • 接続元 IP の制限（CIDR）・有効期限・持ち主が無効なら止める、は API キーと同じ。
  • ライセンスが切れると PostgreSQL 互換の接続も止まる。
方式接続内容
RESTAuthorization: Bearer bk-...GET /v1/data/datasets（一覧）・/schema（列）・POST /v1/data/query（参照）。書き込みを付けたデータセットは /v1/data/datasets/{名前}/rows で追加・更新・削除（ダッシュボード）
PostgreSQL 互換bk-... をパスワードに直接接続Looker Studio / Metabase などの BI ツールから、所有者のデータセット（ビュー）へ直接クエリ。書き込みを付けたデータセットは INSERT / UPDATE / DELETE も可

関連