Base URL: /api
后端默认监听 127.0.0.1:8000，可通过 PAPYRUS_PORT 环境变量覆盖。
独立 MCP 端点默认监听 127.0.0.1:9200，可通过 PAPYRUS_MCP_PORT 覆盖。
持久化：SQLite（node:sqlite，WAL），默认 $HOME/PapyrusData/papyrus.db。
Electron 模式下写接口通常需要 Authorization / auth token（PAPYRUS_AUTH_TOKEN）。
检查服务状态。
响应:
{ "status": "ok" }列出所有卡片。
响应:
{
"success": true,
"cards": [
{ "id": "...", "q": "问题", "a": "答案", "next_review": 1234567890, "interval": 1.0 }
],
"count": 1
}创建卡片。
请求体:
{ "q": "问题", "a": "答案", "tags": ["标签"] }获取单个卡片。
更新卡片。
删除卡片。
获取下一张到期卡片。
响应:
{
"success": true,
"card": { ... },
"due_count": 5,
"total_count": 100
}评分卡片。
请求体:
{ "grade": 1|2|3 } // 1=忘记, 2=模糊, 3=秒杀列出所有笔记。
创建笔记。
请求体:
{
"title": "标题",
"folder": "文件夹",
"content": "内容",
"tags": ["标签"]
}获取单个笔记。
更新笔记（部分更新）。
删除笔记。
从 Obsidian Vault 导入笔记。
请求体:
{
"vault_path": "/path/to/obsidian/vault",
"exclude_folders": [".obsidian", ".git"]
}列出所有文件。
上传文件。
删除文件。
列出指定笔记的关系。
为笔记创建关系。
获取笔记关系图数据。
更新关系。
删除关系。
列出已安装扩展。
安装 / 注册扩展。
从本地路径安装扩展。
卸载扩展。
启用 / 禁用扩展。
获取 UI 设置。
更新 UI 设置。
获取侧边栏设置。
更新侧边栏设置。
全局搜索卡片和笔记。
将当前 SQLite 库备份到 $PAPYRUS_DATA_DIR/backups/。
导出数据。
导入数据。
清空应用数据（危险操作）。
查询 CLI 安装状态。
安装 CLI。
更新 CLI。
运行 CLI 命令。
AI 聊天（流式 SSE）。由 ai.ts 聚合注册。
获取聊天会话列表。
创建新会话。
删除会话。
工具目录。
工具配置。
批准工具调用。
拒绝工具调用。
获取 AI 配置（密钥脱敏）。
更新 AI 配置。
AI 补全。
获取所有提供商和模型列表。
添加自定义提供商。
删除提供商。
连续复习天数。
复习历史。
复习热力图数据。
MCP 健康检查。
MCP 工具列表。
调用 MCP 工具。
MCP 笔记列表。
MCP 单篇笔记。
MCP 创建笔记。
MCP 更新笔记。
MCP 删除笔记。
MCP 搜索笔记。
Vault 索引（批量获取元数据）。
Vault 读取（批量获取内容）。
将 Markdown 渲染为 HTML。
请求体:
{ "content": "# 标题\n\n**粗体** 和 *斜体*" }import { api } from './api';
// 获取笔记列表
const { notes } = await api.listNotes();
// 创建笔记
await api.createNote('标题', '文件夹', '内容', ['标签']);
// 更新笔记
await api.updateNote('note-id', { title: '新标题', content: '新内容' });
// 从 Obsidian 导入
const result = await api.importObsidian('/path/to/vault');
console.log(`导入 ${result.imported} 条，跳过 ${result.skipped} 条`);| 版本 | 更新内容 |
|---|---|
| v2.0.0-beta.12 | 对齐现网路径；补 cli / ui-settings / backup / export / import；注明 SQLite |
| v2.0.0-beta.11 | 补全 API 文档，移除预留标记 |
| v2.0.0-beta.4 | 初始 API 文档 |