← 返回 Import API 列表

导入 .sy.zip 文件

在 GitHub 上查看源码

POST /api/import/importSY

描述

导入通过"导出为 .sy.zip" 功能生成的单个或多个文档的压缩包。这通常用于在不同笔记本之间移动文档，或分享文档给他人导入。

请求参数

请求需要使用 multipart/form-data 格式发送。

参数名 类型 描述 必需
file File 要导入的 .sy.zip 文件。 是
notebook string 目标笔记本的 ID，导入的文档将存放在此笔记本中。 是
toPath string 导入到目标笔记本内的路径（相对于笔记本根目录）。例如 /导入的文档/ 或 / 表示根目录。 是

响应结果

响应体是 JSON 格式。code 为 0 表示成功。导入过程是异步的，API 成功返回仅代表接收文件成功并开始处理。


{
  "code": 0,
  "msg": "",
  "data": null
}

如果请求处理或文件接收、解压、导入过程中出错，code 会是 -1，并包含错误信息。

注意：这是一个社区维护的文档，可能与官方最新版本存在差异。

如果您觉得本文档有帮助，可以考虑赞助支持：爱发电

在线测试

由于此 API 需要上传文件，建议使用 curl、Postman 或其他支持文件上传的工具进行测试。

示例 curl 命令：

curl -X POST \
  "http://127.0.0.1:6806/api/import/importSY" \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -F "file=@/path/to/your/document.sy.zip" \
  -F "notebook=TARGET_NOTEBOOK_ID" \
  -F "toPath=/target/import/path/"