mnapis
接口参考

接口总览(72 路由)

72 路由总表:方法、路径、Max 与 confirm 速查

下表是 72 路由速查。每个端点的交互式文档(参数 Schema、多语言代码示例)见侧边栏「交互式 API」分组(按 Tag 分组,如从 system/get-status 开始)。 发即执行的端点先读危险端点纪律

来源:运行时 GET /capabilities(Bridge API v0.49 / App 4.5.0 / routeCount 72)。 Max = requiresMax(有效 token 下是否另需 MarginNote Max);Cfm = 是否需 confirm:true(JSON body;upload 例外,走 query confirm=1,见脚注①)。 无 Cfm 标记即无 confirm 门,发即执行(prepare/submit/focus/discard、打快照、ui-state/applyinstall/code 等)。 Cfm ✅ 中仅六个重动词为真 dry-run(不带回 422 + 已验事实),其余仅门控,须用只读端点自核。 详情见各分域页与危险端点纪律;契约原文见 运行时能力

方法路径MaxCfm说明
GET/status探活(免鉴权唯一)
GET/capabilities运行时能力清单
GET/guide运行时规程 Markdown
GET/context用户此刻上下文
GET/install安装脚本(?code= 一次性)
POST/install/code安装辅助
POST/mcpMCP 通道(GET 未实现)
GET/library/study-sets列学习集
POST/library/study-sets新建空学习集
POST/library/documents/upload上传文档(字节+query,confirm=1
POST/library/documents/{id}/delete删资料库文档(仅干净撤销)
GET/library/folders列文档文件夹
GET/study-sets/{id}/documents列集内文档
POST/study-sets/{id}/documents集内加文档
POST/study-sets/{id}/documents/{id}/delete集内移除文档(失回源警告)
POST/study-sets/{id}/open打开学习集
GET/study-sets/{id}/tree脑图树(扁平 nodes)
GET/study-sets/{id}/sub-maps列子脑图
GET/study-sets/{id}/snapshots列快照
POST/study-sets/{id}/snapshots打快照
POST/study-sets/{id}/delete删学习集(最重)
GET/study-sets/{id}/notebooks集引用的文档笔记本
GET/study-sets/{id}/hashtags集标签树
GET/study-sets/{id}/note-palette16 色摘录色板
POST/study-sets/{id}/mindmap-print/preview脑图打印计划
POST/study-sets/{id}/mindmap-print/export按计划导出脑图 PDF
GET/documents/{id}/outline目录(segments)
GET/documents/{id}/pages页文本(&blocks=1 探针)
GET/documents/{id}/pages/{index}/parts页视觉注释面
GET/documents/{id}/pages/{index}/content/{id}页手写/留白图
GET/documents/{id}/toc-candidatesAI 目录标题候选
POST/documents/{id}/toc写/切 AI 目录
POST/documents/{id}/locate按原文找位置
POST/documents/{id}/export导出扁平 PDF
GET/documents/{id}/sync-status单文档同步对账
POST/notes/batch-get批量读卡(≤200)
POST/notes/hashtags写 hashtag
POST/notes/metadata改样式
POST/notes/move移动(≤50)
POST/notes/copy复制分支(≤50 根)
POST/notes/delete删卡(≤50,同集)
POST/notes/fold折叠(≤200)
GET/notes/{id}/content/{id}卡二进制项
GET/notes/{id}/render整卡渲染
POST/notes/{id}/image-occlusions原生图片挖空
POST/notes/{id}/title改标题
POST/notes/{id}/text改正文
POST/notes/{id}/comments追加评论
POST/notes/{id}/comments/{index}改写评论(1..N)
POST/notes/{id}/comments/{index}/delete删除评论
POST/notes/{id}/merge-branch合并分支
POST/notes/{id}/fold-into-sub-map折成子脑图/展回
POST/notes/{id}/focus定位到卡
GET/decks列复习卡组
POST/decks建卡组
GET/decks/{id}/cards列复习卡
POST/decks/{id}/cards加复习卡(≤50)
POST/decks/{id}/open打开卡组
POST/bundles/prepare准备任务包
GET/bundles列包/作业
GET/bundles/{id}/files列包文件/取单文件
POST/bundles/{id}/submit提交导入(无 confirm 门)
POST/bundles/{id}/focus聚焦结果
POST/bundles/{id}/discard删包/取消
POST/snapshots/{id}/restore回退快照
GET/search全库搜索
GET/sync/legacy/status旧同步诊断
GET/sync/legacy/events旧同步增量事件
POST/sync/legacy/recheck旧同步安全重核
POST/sync/legacy/inventory旧同步只读盘点
GET/ui-state读界面状态
POST/ui-state/apply应用界面状态(差量)

uploadconfirm=1 走 query,不是 JSON body 的 confirm:true