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。