API

すべてのワークスペースには、DocsbookのREST APIへの呼び出しを認証するために使用される1つの公開APIキーがあります。今日、APIは1つの機能を公開しています：ワークスペースのAIドキュメントチャットをプレーンRESTエンドポイントとしてエクスポートすることです — これは、公開されたドキュメントサイトのAIチャットウィジェットを支える同じグラウンデッドアンサーエンジンであり、それを基に独自のサポートボット、Slack統合、またはCLIを構築することができます。

APIキーの取得#

統合を開きます — /chat入力のアバタードロップダウンから、または管理パネルのプロフィールドロップダウンからアクセスできます。そこから、キーを表示（マスクまたは表示）、コピー、またはリセットできます。

ワークスペースごとに1つのライブキーがあります。リセットすると、古いキーは即座に無効になります — キーの履歴はないため、リセットする前に呼び出し元を更新してください。

認証#

すべてのリクエストはBearerトークンで認証されます — あなたのワークスペースのAPIキーです。

Authorization: Bearer dbk_<your_api_key>

キーは秘密にしてください — それはあなたのワークスペースのAIチャットへの完全なアクセスを許可し、あなたのアカウントのAI予算に対して請求されます（ドキュメントチャットウィジェットが使用するのと同じ予算です；API専用のクォータはありません）。

curl -X POST https://docsbook.io/api/v1/chat \
  -H "Authorization: Bearer dbk_<your_api_key>" \
  -H "Content-Type: application/json" \
  -d '{"question": "How do I set a custom domain?"}'

{
  "answer": "You can set a custom domain from the Branding tab...",
  "refs": [{ "pagePath": "design/domains", "title": "Custom Domains", "heading": "Setup" }],
  "follow_up_questions": ["What SSL certificate is used?", "Can I use a subdomain?"]
}