DigitalBase Docs (β版)製品サイト

OpenAI 互換 API

DigitalBase は OpenAI 互換のエンドポイント（/v1/*）を提供します。既存の OpenAI SDK / ツールから、接続先（base URL）と API キーを差し替えるだけで利用できます。Anthropic 互換の /v1/messages にも対応します。

対象:開発者 / 管理者
補足

このページは「リファレンス」型です。すべてのリクエストに Authorization: Bearer <API_KEY>（API キー）が必要です。ベース URL は http://<HOST>:8000/v1 です。

エンドポイント一覧

エンドポイント説明
POST /v1/chat/completionsチャット補完（ストリーミング対応）
POST /v1/embeddings埋め込みベクトルの生成
POST /v1/messagesAnthropic 互換のメッセージ API
GET /v1/models利用可能なモデル一覧
GET/POST/DELETE /v1/assistantsアシスタント（Bot）の管理
GET /v1/vector_storesナレッジ（RAG）一覧・参照
POST/GET/DELETE /v1/api-keysAPI キーの管理
/v1/bi-keys・/v1/data/*BI キーとデータクエリ（SQL / BI）

利用例

curl http://<HOST>:8000/v1/chat/completions \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "<model>",
    "messages": [{"role": "user", "content": "こんにちは"}],
    "stream": true
  }'

OpenAI Python SDK からは base_url を差し替えるだけで利用できます。

from openai import OpenAI

client = OpenAI(base_url="http://<HOST>:8000/v1", api_key="<API_KEY>")
res = client.chat.completions.create(
    model="<model>",
    messages=[{"role": "user", "content": "こんにちは"}],
)

アシスタント（Bot）を指定する

model にアシスタント ID（asst_ で始まる）を渡すと、そのアシスタントの設定（ナレッジ・プロンプト・ツール）で応答します。

RAG の出典

RAG を使う応答では、レスポンスの拡張フィールド x_digitalbase.sources に参照した社内文書（出典）が含まれます。

関連