Common.brand
MD Import Docs

导入任务

上传 ZIP、创建任务、轮询进度并渲染 Markdown。

第一步：上传 ZIP

上传接口接收 multipart/form-data，字段名固定为 archive。

curl -X POST 'https://api.fafafa.ai/uploads/md-import' \
  -F 'archive=@./articles.zip'

第二步：创建导入任务

curl -X POST '/api/v1/md/import' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{
    "uploadRelativePath": "md-import/uploads/2026/03/articles.zip",
    "archiveFilename": "articles.zip",
    "archiveSize": 102400
  }'

常用可选字段：

  • themeId
  • darkMode
  • directoryPath
  • saveFolderId
  • mdfileId
  • entryMarkdown

第三步：轮询状态

curl '/api/v1/md/import/jobs/YOUR_JOB_ID' \
  -H 'Authorization: Bearer YOUR_API_KEY'

关键字段：

  • status
  • progress
  • currentStage
  • message

推荐 ZIP 结构

project.zip
├─ README.md
├─ articles/
│  ├─ intro.md
│  └─ launch.md
└─ assets/
   ├─ cover.png
   └─ chart.jpg

导入后渲染

POST /api/v1/md/render

支持直接传 markdown，也支持传 mdfileId。