MD Import Docs

Import Jobs

Upload ZIP packages, create jobs, poll progress, and render Markdown.

Step 1: Upload ZIP

The upload endpoint expects multipart/form-data with the field name archive.

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

Step 2: Create an import job

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
  }'

Common optional fields:

themeId
darkMode
directoryPath
saveFolderId
mdfileId
entryMarkdown

Step 3: Poll status

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

Watch:

status
progress
currentStage
message

Recommended ZIP layout

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

Render after import

POST /api/v1/md/render

You can pass raw markdown or an existing mdfileId.