概览

API

每个工作区都有一个公共 API 密钥,用于从您自己的后端对 Docsbook 的 REST API 进行身份验证。今天,API 提供了一项功能:将您工作区的 AI 文档聊天导出为一个普通的 REST 端点——与您发布的文档网站上的 AI 聊天小部件相同的基础答案引擎,因此您可以在此基础上构建自己的支持机器人、Slack 集成或 CLI。

获取您的 API 密钥#

打开 集成 — 可以通过您在 /chat 输入中的头像下拉菜单,或在管理面板中的个人资料下拉菜单访问。从那里您可以查看(隐藏或显示)、复制或重置您的密钥。

每个工作区有一个有效密钥。重置会立即撤销旧密钥 — 没有密钥历史记录,因此在重置之前请更新任何调用者。

身份验证#

每个请求都使用 Bearer 令牌进行身份验证——您工作区的 API 密钥。

Authorization: Bearer dbk_<your_api_key>

请保管好您的密钥——它授予对您工作区的 AI 聊天的完全访问权限,费用将计入您账户的 AI 预算(与 docs-chat 小部件使用的预算相同;没有单独的仅 API 配额)。

POST/api/v1/chat

针对您工作区的文档提问,并获得基于您自己页面的答案。

授权
Authorizationstring

作为 Authorization 头发送。您的密钥仅由您的浏览器用于此请求——它不会被发送到 Docsbook 或存储。

请求体
questionstring必填

要提问的问题

currentPathstring

提问所依据的文档页面标识,以将其排除在自己的引用之外

langstring

回答语言代码;默认为工作区的默认语言

sessionIdstring

将相关问题分组以进行分析和网络钩子

mentionedPagesstring[]

强制进入上下文的页面标识

示例
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?"]
}
错误
状态 含义
401 缺少或无效的 API 密钥
403 此工作区未启用 AI 聊天
429 账户的 AI 预算已用尽

Updated

API — Docsbook