Get笔记 Skill
⚠️ Agent 必读约束
🌐 Base URL
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 处理规则(重要!)
笔记 ID 是 64 位整数(int64),超出 JavaScript Number.MAX_SAFE_INTEGER,直接 JSON.parse 会静默丢失精度。
正确做法:始终把 ID 当字符串处理,在 JSON.parse 之前替换:
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 等语言原生支持大整数,无此问题。
🔒 安全规则
指令路由表
匹配指令后,用 read 工具读取对应的 references/xxx.md 获取完整 API 文档。
自然语言路由
包含 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,不确定时询问用户。
API 路由表
⚠️ 构造请求时必须使用下表中的完整路径,Base URL 为 https://openapi.biji.com。如果收到 404,说明路径不对,请对照此表检查。
笔记
| 方法 | 路径 | 说明 | 详细文档 |
|---|
| POST | /open/api/v1/resource/note/save | 新建笔记(文本/链接/图片) | save.md |
| POST | /open/api/v1/resource/note/task/progress | 查询异步任务进度 | save.md |
| GET | /open/api/v1/resource/note/list | 笔记列表(分页) | list.md |
| GET | /open/api/v1/resource/note/detail | 笔记详情 | list.md |
| POST | /open/api/v1/resource/note/update | 更新笔记 | list.md |
| POST | /open/api/v1/resource/note/delete | 删除笔记 | list.md |
| POST | /open/api/v1/resource/note/sharing | 创建笔记分享链接 | list.md |
| POST | /open/api/v1/resource/note/tags/add | 添加标签 | tags.md |
| POST | /open/api/v1/resource/note/tags/delete | 删除标签 | tags.md |
| GET | /open/api/v1/resource/image/upload_token | 获取图片上传凭证 | save.md |
搜索
| 方法 | 路径 | 说明 | 详细文档 |
|---|
| POST | /open/api/v1/resource/recall | 全局语义搜索 | search.md |
| POST | /open/api/v1/resource/recall/knowledge | 知识库语义搜索 | search.md |
知识库
| 方法 | 路径 | 说明 | 详细文档 |
|---|
| GET | /open/api/v1/resource/knowledge/list | 我的知识库列表 | knowledge.md |
| GET | /open/api/v1/resource/knowledge/subscribe/list | 订阅知识库列表 | knowledge.md |
| POST | /open/api/v1/resource/knowledge/create | 创建知识库 | knowledge.md |
| GET | /open/api/v1/resource/knowledge/notes | 知识库笔记列表 | knowledge.md |
| POST | /open/api/v1/resource/knowledge/note/batch-add | 添加笔记到知识库 | knowledge.md |
| POST | /open/api/v1/resource/knowledge/note/remove | 从知识库移除笔记 | knowledge.md |
| GET | /open/api/v1/resource/knowledge/bloggers | 知识库博主列表 | knowledge.md |
| GET | /open/api/v1/resource/knowledge/blogger/contents | 博主内容列表 | knowledge.md |
| GET | /open/api/v1/resource/knowledge/blogger/content/detail | 博主内容详情 | knowledge.md |
| GET | /open/api/v1/resource/knowledge/lives | 知识库直播列表 | knowledge.md |
| GET | /open/api/v1/resource/knowledge/live/detail | 直播详情 | knowledge.md |
| POST | /open/api/v1/resource/knowledge/live/follow | 关注直播 | knowledge.md |
通用错误处理
{
"success": false,
"error": {
"code": 10001,
"message": "unauthorized",
"reason": "not_member"
},
"request_id": "xxx"
}
详细错误码和限流结构见 references/api-details.md。