OpenAI 互換 API

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

エンドポイント一覧

OpenAI / Anthropic 互換

標準 SDK / ツールからそのまま利用できる、互換エンドポイントです。

DigitalBase 独自（管理系）

OpenAI / Anthropic の標準仕様にはない、DigitalBase 独自のエンドポイントです。詳細は各ページを参照してください。

組み込み API リファレンス

稼働中のサーバは、実際に利用できる API のリファレンスを提供します。

ReDoc の表示に必要なファイルは製品に同梱されているため、インターネットに接続できない環境でも表示できます。[API キー] 画面の [API リファレンス] からも開けます。API の仕様を公開しない場合は、GATEWAY_DOCS_ENABLED=false を設定すると両方の URL を非表示にできます。

リファレンスの Tools セクションには、組み込みツールごとの権限レベル、提示に必要なスコープ、引数が表示されます。GET /v1/tools は、API キーに紐づくアシスタントのスコープと maxLevel から、そのキーに実際に提示するツールだけを OpenAI function 形式で返します。結果は MCP の tools/list と同じ基準で決まります。アシスタントに紐づかないキーでは空の一覧を返します。

利用例

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": "こんにちは"}],
)

リクエストパラメータとモデル別の挙動

/v1/chat/completions の主なパラメータは、接続先のモデル（バックエンド）によって扱いが異なります。表にない標準パラメータ（stop / seed / response_format / penalties / logprobs など）はローカルモデルにそのまま転送され、クラウドモデルでは無視されます。n は 1 のみ対応し、2 以上は 400 になります。

reasoning_effort（思考の深さ）

値は "none" / "low" / "medium" / "high" / "max" で、未指定はモデル既定です。互換のため metadata.xdb.thinking（bool も可。true=high / false=none）でも指定でき、両方ある場合は metadata 側が優先されます。旧称 metadata.digitalbase も引き続き受け付けます。思考機能のないモデルに指定してもエラーにはなりません。

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

model にアシスタントの名前（または asst_ で始まる ID）を渡すと、そのアシスタントの設定（ナレッジ・プロンプト・ツール）で応答します。GET /v1/models にもアシスタントが名前で並びます。

model には GET /v1/models が返す ID（モデル名またはアシスタント名）かアシスタント ID を指定します（一覧はチャット用モデルのみで、埋め込みモデルは /v1/embeddings 専用のため並びません）。一覧に無いモデル名を指定した場合、または model を省略した場合は既定のチャットモデルで応答します（既存クライアントの固定モデル名でそのまま動く drop-in 互換。応答の model には実際に使ったモデル ID が入ります）。存在しない、または参照できないアシスタント ID（asst_...）は 404（code: model_not_found）を返します。

エラー応答

エラーは OpenAI と同じ形の JSON で返します（/v1/messages* は Anthropic 形式 {"type":"error","error":{"type","message"}}）。SDK はこの code / type を読んで理由を判別できます。

{"error": {"message": "The model 'asst_xxxx' does not exist or you do not have access to it", "type": "invalid_request_error", "param": "model", "code": "model_not_found"}}

RAG の出典

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

Anthropic 互換（/v1/messages）

Anthropic Messages API 形式のリクエストにも対応します。Claude 向けの SDK やツールから、接続先と API キーを差し替えるだけで利用できます。

• 認証は OpenAI 互換と同じ API キー（sk-）を使います。
• system / messages（content ブロック）・tools / tool_choice・ストリーミング（SSE）に対応します。
• 受信時に内部で OpenAI 形式へ変換して処理し、応答を Anthropic 形式（message_start / content_block_delta / message_stop など）で返します。
• model はそのまま渡され、クラウド振り分け／ローカルモデルで解決されます。
• thinking（{"type":"adaptive"} / {"type":"disabled"} など）と output_config.effort は、上記の reasoning_effort と同じ思考制御に変換されます（disabled=none、adaptive/enabled=effort 指定または high）。

関連

• APIアクセスキー — 認証キーの発行・制限
• MCP — ツールを外部エージェントに公開
• AIエージェント