开发者

Get笔记提供开放 API，让你把知识库的 AI 搜索和召回能力接入自己的应用。不管你是做聊天机器人、内部知识助手，还是搭配 Dify、扣子等平台使用，都可以快速接入。

目前 API 处于免审公测期，所有接口可能会调整或优化。公测期间免费使用，正式商业化后可能收费。不建议公测期间用于商业产品。

是什么

Get笔记 OpenAPI 提供两个核心能力：

知识库搜索：向知识库提问，AI 会从你的笔记、文件、关注的博主内容中找到答案，支持深度思考模式和流式返回
知识库召回：根据问题召回最相关的内容片段，返回相似度评分，适合做二次加工

你可以通过以下方式使用：

接入方式	适合谁	说明
直接调用 API	有开发能力的用户	最灵活，完全自定义
Dify 外部知识库	Dify 用户	作为 Dify 的外部知识源
扣子插件	扣子用户	在扣子工作流或 Agent 中调用

怎么用

第一步：获取 API 配置信息

打开 Get笔记知识库网页版，点击顶部的「API 设置」按钮，进入配置页面。

知识库网页版顶部导航栏，右侧显示「API 设置」按钮，点击可打开 API 配置页面

你会看到两个关键参数：

参数值 1（API Key）：用于身份验证
参数值 2（知识库 ID）：指定要查询的知识库

API 配置页面，显示两个参数值：参数值1为 API Key（用于认证），参数值2为知识库 ID（用于指定查询的知识库），每个参数旁有复制按钮

请妥善保管 API Key，不要提交到公开代码仓库。如怀疑泄露，立即重新生成。

第二步：调用 API

基础信息：

接口地址：https://open-api.biji.com/getnote/openapi
认证方式：在请求头中添加 Authorization: Bearer {你的API Key}
频率限制：每秒 2 次请求（QPS），每天 5000 次

知识库搜索（获取 AI 回答）：

curl -X POST https://open-api.biji.com/getnote/openapi/knowledge/search \
  -H "Authorization: Bearer {你的API Key}" \
  -H "Content-Type: application/json" \
  -d '{
    "question": "你的问题",
    "topic_ids": ["你的知识库ID"],
    "deep_seek": false,
    "refs": true
  }'

参数说明：

参数	类型	必填	说明
question	string	是	要搜索的问题
topic_ids	string[]	是	知识库 ID 列表（目前支持 1 个）
deep_seek	bool	是	是否开启深度思考
refs	bool	否	是否返回引用来源，默认 false
history	array	否	对话历史，用于追问

流式接口地址为 /knowledge/search/stream，返回的 msg_type 含义：

msg_type	含义
1	AI 回答内容
3	结束标记 [END]
6	处理流程信息
21	深度思考过程（逐字返回）
22	思考耗时
105	引用来源数据
8	风控提醒
0	错误信息

知识库召回（获取相关片段）：

curl -X POST https://open-api.biji.com/getnote/openapi/knowledge/search/recall \
  -H "Authorization: Bearer {你的API Key}" \
  -H "Content-Type: application/json" \
  -d '{
    "question": "你的问题",
    "topic_ids": ["你的知识库ID"],
    "top_k": 10
  }'

返回结果中每条记录包含：title（标题）、content（内容）、score（相似度评分）、type（来源类型：FILE / NOTE / BLOGGER）。