MuseCanto 开发者文档
使用用户 API 密钥，在浏览器之外集成 MuseCanto 知识库与自动化流程。
欢迎使用 MuseCanto 开发者文档。通过用户 API 密钥，可在脚本、备份任务、CI 流水线以及 n8n、自建 MCP 等场景中读写知识库内容，无需依赖浏览器 Session。
文档持续更新
Open API 正在扩展中。导出与导入已可用；更多接口与集成指南会随版本发布陆续补充到本站。
鉴权方式
所有面向机器的接口均使用 Bearer 携带用户 API 密钥：
Authorization: Bearer YOUR_API_KEY- 登录后打开 设置 → API 密钥。
- 创建密钥并立即复制——完整密钥仅显示一次。
- 每次请求都需携带该密钥；密钥代表你的账号操作，不使用浏览器 Cookie。
请妥善保管密钥
持有密钥且知道知识库 slug 的人，可访问你账号下对应知识库。密钥泄露后请尽快删除并重新创建。
基础地址与路由前缀
| 场景 | 值 |
|---|---|
| Open API 前缀 | /api/v1/open/* |
| 浏览器 / Session 路由 | /api/books/*（需登录 Cookie，勿在脚本中调用） |
示例中的 https://your-domain.com 请替换为你的部署地址（本地开发可为 http://localhost:3000）。
可用接口
每个知识库在 URL 中有 book slug，例如 /app/books/a1b2c3d4 对应 slug a1b2c3d4。
快速开始
导出知识库内全部文档：
curl -sS \
-H "Authorization: Bearer YOUR_API_KEY" \
"https://your-domain.com/api/v1/open/books/BOOK_SLUG/docs"将 Markdown 导入为新文档：
curl -sS -X POST \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"title":"我的文档","format":"markdown","content":"# 你好\n\n正文。"}' \
"https://your-domain.com/api/v1/open/books/BOOK_SLUG/docs/import"查询参数、响应字段与错误码详见各 API 页面。
即将推出
文档与 Open API 计划补充的能力包括：
- 通过 API 更新、删除已有文档
- 大规模导出的分页
- Webhook 与事件订阅
- 更多集成示例与 SDK 说明
请关注本站文档或产品更新说明。
OpenAPI
部署启用后，管理员可在 OpenAPI（/api/docs）浏览合并后的路由。Open API 接口标签为 Open API · Books，统一使用 /api/v1/open/* 前缀。