Fast Note Sync Service REST API 完全参考：用 100+ 个接口自动化管理 Obsidian 笔记

Fast Note Sync Service REST API 完全参考用 100 个接口自动化管理 Obsidian 笔记【免费下载链接】fast-note-sync-serviceHigh-performance, low-latency note synchronization, online management, and remote REST API service platform.项目地址: https://gitcode.com/gh_mirrors/fa/fast-note-sync-serviceFast Note Sync Service简称 FNS是一款高性能、低延迟的 Obsidian 笔记同步服务提供在线管理与远程REST API能力。基于 Golang WebSocket React 构建它支持多设备笔记同步、附件分片传输、笔记历史版本、Git 自动推送与多云备份并通过 80 个 REST 接口加上 WebSocket 实时通道与 MCP 协议实现超过 100 个自动化操作入口让脚本、CI 任务和 AI 助手都能直接读写你的笔记库 。REST API 快速入门认证方式与统一响应结构所有接口定义由 OpenAPI 生成完整文档见 REST_API.md机器可读规格见 swagger.yaml接口源码位于 internal/routers/api_router/ 目录。项目说明Base URLhttp://{host}:9000/api认证方式请求头携带Authorization: {token}Token 由登录接口签发分页参数page默认 1、page_size默认 10最大 100所有接口返回统一 JSON 结构{ code: 1, status: true, message: OK, data: { list: [], pager: { page: 1, pageSize: 10, totalRows: 0 } } }常见错误码407用户名不存在、414保险库不存在、428笔记不存在、445需要管理员权限、507未登录、508会话过期。排查自动化任务时先看code字段即可快速定位问题。11 个功能模块 × 80 REST 接口全景速览模块接口数核心能力Note 笔记14CRUD、追加/前置内容、正则替换、双向链接、历史版本File 附件7内容读写、回收站、重命名Folder 文件夹7文件夹 CRUD 与目录树Share 分享6分享链接、密码保护、短链Backup 备份5S3/OSS/WebDAV 备份与历史查询GitSync Git 同步7自动推送到远程仓库、参数校验Storage 存储5多云存储配置与连接校验Setting 设置5键值设置与.obsidian配置同步Vault 保险库4Vault 管理User 用户4注册、登录、改密System/Config 系统25健康检查、运维操作、管理员配置笔记管理 API自动创建、追加与批量替换 Obsidian 笔记这是最高频使用的模块handler_note.go 中的 14 个端点覆盖了笔记的完整生命周期接口方法用途/api/noteGET / POST / DELETE读取、创建/修改/重命名、删除进回收站/api/note/append、/api/note/prependPOST末尾追加 / 开头插入frontmatter 之后不覆盖原文/api/note/replacePOST查找替换支持正则表达式/api/note/move、/api/note/renamePOST移动与重命名/api/note/recycle-clearDELETE清空回收站/api/note/restorePUT从回收站恢复/api/note/backlinks、/api/note/outlinksGET反向链接 / 出链查询/api/note/frontmatterPATCH批量增删 YAML frontmatter 字段几个自动化场景特别值得注意每日日志调用POST /api/note/append把会议记录追加到Daily/2026-10-04.md天然幂等不破坏已有内容批量清理POST /api/note/replace传入正则一次统一全库旧模板知识图谱构建backlinksoutlinks双接口可直接导出双向链接关系全文检索GET /api/notes内置 SQLite FTS5 全文搜索引擎searchMode支持path、content、regex三种模式配合sortBy/sortOrder自由排序。文件夹与保险库 API批量整理 Vault 目录结构接口方法用途/api/vaultGET / POST / DELETE保险库列表 / 创建或更新 / 删除/api/folderGET / POST / DELETE文件夹详情 / 创建 / 删除/api/folder/treeGET一次性拉取整棵目录树/api/folder/files、/api/folder/notesGET列出文件夹内的附件与笔记配合文件夹同步支持创建、重命名、移动、删除可以在脚本中先建好Inbox、Projects、Archive骨架再批量移动笔记归档。附件文件 API图片与文档同步接口一览接口方法用途/api/fileGET / DELETE获取附件内容 / 删除/api/file/infoGET附件元信息/api/filesGET分页文件列表/api/file/rename、/api/file/restorePOST / PUT重命名 / 从回收站恢复/api/file/recycle-clearDELETE清空附件回收站大文件采用分片上传/下载分片大小可配置适合脚本批量同步图片或 PDF 资料库。备份与存储配置 APIS3、OSS、WebDAV 一键备份接口方法用途/api/backup/configPOST / DELETE创建或更新备份配置/api/backup/configsGET配置列表/api/backup/executePOST手动触发一次备份/api/backup/historysGET备份历史分页/api/storageGET / POST / DELETE存储配置管理/api/storage/validatePOST校验存储连接是否可用支持 S3、OSS、R2、WebDAV、本地文件系统等协议可配置定时全量/增量 ZIP 备份、过期保留天数自动清理以及 Vault 到远端存储的单向镜像同步。Git 自动同步笔记变更自动推送远程仓库/api/git-sync/*共 7 个端点包括POST /api/git-sync/validate参数校验、POST /api/git-sync/config/execute手动触发、GET /api/git-sync/histories同步历史。笔记或附件一旦变更服务端自动 commit 并 push 到远程 Git 仓库任务完成后自动释放内存实现云端 Git 双保险。分享 API生成带密码保护的笔记分享链接接口方法用途/api/shareGET / POST / DELETE查询分享 / 创建分享 / 取消分享/api/share/note、/api/share/fileGET凭分享 Token 只读访问笔记或附件/api/share/password、/api/share/short_link—密码保护与短链生成/api/sharesGET分享列表支持排序分页创建分享时会自动解析笔记中引用的图片、音视频附件并授权无需手动逐个添加。用户与系统运维 API从登录到健康检查的完整流程认证四连handler_user.goPOST /api/user/register → 注册服务器可关闭开放注册 POST /api/user/login → 登录返回 Token后续所有接口的门票 GET /api/user/info → 当前用户信息 POST /api/user/change_password → 修改密码运维接口需管理员权限GET /api/health探针健康检查适合接入监控告警、GET /api/version与/api/version/probe版本与升级源延迟探测、GET /api/admin/systeminfo运行时信息、GET /api/admin/restart//api/admin/gc//api/admin/upgrade重启、手动 GC、在线升级、GET /api/admin/ws_clients当前 WebSocket 在线客户端。MCP 协议与 WebSocket让 AI 直接操作你的笔记库REST API 只是 FNS 的第一层能力WebSocket 实时通道笔记变更毫秒级推送到所有在线设备协议细节见 SyncProtocol.md原生 MCP 支持FNS 可作为 MCP Server 接入 Cherry Studio、Cursor 等 AI 客户端让 AI 直接读写个人笔记改动实时同步到全部设备。技能描述见 docs/skills/fns-mcp/MCP 接口定义见 mcp_dto.go。快速上手与资源汇总推荐用 Docker 部署镜像定义见 Dockerfile编排文件见 docker/docker-compose.yaml。启动后默认 9000 端口提供 Web 控制台REST 路由挂在/api下拿到登录返回的 Token 后即可开始自动化之旅 。资源路径REST API 完整文档docs/REST_API.mdOpenAPI 规格Swaggerdocs/swagger.yamlWebSocket 同步协议docs/SyncProtocol.md接口路由源码internal/routers/api_router/请求模型定义internal/dto/需要从零搭建时克隆仓库即可开始git clone https://gitcode.com/gh_mirrors/fa/fast-note-sync-service掌握这套 REST API 后无论是每日日志自动追加、全库正则清理、目录批量归档还是把笔记库接入 CI 与 AI 工作流都能在几行脚本内完成。【免费下载链接】fast-note-sync-serviceHigh-performance, low-latency note synchronization, online management, and remote REST API service platform.项目地址: https://gitcode.com/gh_mirrors/fa/fast-note-sync-service创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考