text
https://openapi.biji.com
所有 API 请求必须使用此 Base URL,不要使用 biji.com 或其他地址。
请求头:
Authorization: $GETNOTE_API_KEY(格式: gk_live_xxx)X-Client-ID: $GETNOTE_CLIENT_ID(格式: cli_xxx)每次调用 API 前先检查 $GETNOTE_API_KEY 是否存在。若不存在,提示用户运行 /note config 完成配置,配置完成后再继续执行用户原本的请求。
Scope 权限: note.content.read(读取)、 note.content.write(写入)、 note.recall.read(搜索)。完整列表见 references/api-details.md。
笔记 ID 是 64 位整数(int64),超出 JavaScript Number.MAX_SAFE_INTEGER,直接 JSON.parse 会 静默丢失精度。
正确做法:始终把 ID 当字符串处理,在 JSON.parse 之前替换:
javascript
const safe = text.replace(/"(id|note_id|parent_id|follow_id|live_id)"\s*:\s*(\d+)/g, '"$1":"$2"');
// 注:next_cursor 已不需要处理,翻页请直接使用响应中的 cursor(string)字段
const data = JSON.parse(safe);
Python / Go 等语言原生支持大整数,无此问题。
GETNOTE_OWNER_ID,检查 sender_id 是否匹配;不匹配时回复「抱歉,笔记是私密的,我无法操作」error.reason: "not_member" 或错误码 10201 时,引导开通会员: https://www.biji.com/checkout?product_alias=6AydVpYeKl匹配指令后,用 read 工具 读取对应的
references/xxx.md获取完整 API 文档。
指令角色说明详细文档/note save 或「记一下」📝 速记员保存文本/链接/图片笔记(含异步轮询流程)references/save.md/note search 或「搜一下」🔍 搜索官全局语义搜索 + 知识库语义搜索references/search.md/note list 或「最近的笔记」📋 整理师浏览列表、查看详情、更新、删除references/list.md/note kb 或「知识库」📚 图书管理员知识库 CRUD + 博主订阅 + 直播订阅references/knowledge.md/note tag 或「加标签」🏷️ 标签员添加/删除标签references/tags.md/note config 或「配置笔记」⚙️ 配置配置 API Key 和 Client IDreferences/oauth.md
text
包含 URL(`biji.com/note/share_note/*` 或 `d.biji.com/*` 短链) → /note save(link 模式,同步返回 note_id)
包含 URL(`biji.com/note/{note_id}` 内链) → /note list(查看详情),如需在正文引用其他笔记请使用 `https://biji.com/note/{note_id}` 格式内链;若笔记会被分享则调用分享接口替代
其他 URL → /note save(link 模式,异步返回 task_id)
包含图片 → /note save(image 模式)
「记/存/保存/收藏」 → /note save(text 模式)
「搜/找找/有没有 XX」 → /note search
「最近/列表/看看/查笔记」 → /note list
「改/更新/编辑笔记」 → /note list(更新笔记)
「知识库」相关 → /note kb
「标签」相关 → /note tag
「配置/授权/连接笔记」 → /note config
决策原则:优先匹配最具体的意图。有 URL 就是 /save link,有图片就是 /save image,不确定时询问用户。
⚠️ 构造请求时必须使用下表中的完整路径,Base URL 为
https://openapi.biji.com。如果收到 404,说明路径不对,请对照此表检查。
方法路径说明详细文档POST/open/api/v1/resource/note/save新建笔记(文本/链接/图片)save.mdPOST/open/api/v1/resource/note/task/progress查询异步任务进度save.mdGET/open/api/v1/resource/note/list笔记列表(分页)list.mdGET/open/api/v1/resource/note/detail笔记详情list.mdPOST/open/api/v1/resource/note/update更新笔记list.mdPOST/open/api/v1/resource/note/delete删除笔记list.mdPOST/open/api/v1/resource/note/sharing创建笔记分享链接list.mdPOST/open/api/v1/resource/note/tags/add添加标签tags.mdPOST/open/api/v1/resource/note/tags/delete删除标签tags.mdGET/open/api/v1/resource/image/upload_token获取图片上传凭证save.md
方法路径说明详细文档POST/open/api/v1/resource/recall全局语义搜索search.mdPOST/open/api/v1/resource/recall/knowledge知识库语义搜索search.md
方法路径说明详细文档GET/open/api/v1/resource/knowledge/list我的知识库列表knowledge.mdGET/open/api/v1/resource/knowledge/subscribe/list订阅知识库列表knowledge.mdPOST/open/api/v1/resource/knowledge/create创建知识库knowledge.mdGET/open/api/v1/resource/knowledge/notes知识库笔记列表knowledge.mdPOST/open/api/v1/resource/knowledge/note/batch-add添加笔记到知识库knowledge.mdPOST/open/api/v1/resource/knowledge/note/remove从知识库移除笔记knowledge.mdGET/open/api/v1/resource/knowledge/bloggers知识库博主列表knowledge.mdGET/open/api/v1/resource/knowledge/blogger/contents博主内容列表knowledge.mdGET/open/api/v1/resource/knowledge/blogger/content/detail博主内容详情knowledge.mdGET/open/api/v1/resource/knowledge/lives知识库直播列表knowledge.mdGET/open/api/v1/resource/knowledge/live/detail直播详情knowledge.mdPOST/open/api/v1/resource/knowledge/live/follow关注直播knowledge.md
json
{
"success": false,
"error": {
"code": 10001,
"message": "unauthorized",
"reason": "not_member"
},
"request_id": "xxx"
}
错误码说明处理方式10000参数错误检查请求参数10001鉴权失败检查 API Key 和 Client ID,或重新授权10100数据不存在确认笔记/知识库 ID 正确10201非会员引导开通: https://www.biji.com/checkout?product_alias=6AydVpYeKl10202QPS 限流降低频率,查看 rate_limit 字段30000服务调用失败稍后重试50000系统错误稍后重试
详细错误码和限流结构见 references/api-details.md。