通过 REST API 转换 Markdown

Available in Start planBeta

使用 Postman

在我们的Postman 集合中实验转换 API。

导入 API 端点

POST /import

将 .md 文件（或 gfm）转换为 Tiptap JSON。

curl -X POST "https://api.tiptap.dev/v1/convert/import?format=md" \
  -H "Authorization: Bearer <your-jwt-token>" \
  -H "X-App-Id: <your-app-id>" \
  -F "file=@/path/to/file.md"

导入 API 头部

头部	描述
`Authorization`	`Bearer <your-jwt-token>`
`X-App-Id`	来自https://cloud.tiptap.dev/convert-settings的 Convert 应用 ID

导入 API 字段

字段	描述
`file`	要转换的 Markdown 文件
`imageUploadCallbackUrl`	可选端点，用于处理 Markdown 文件引用的本地图像

导出 API 端点

POST /export

将 Tiptap JSON 转换为 .md 或 .gfm。

curl -X POST "https://api.tiptap.dev/v1/convert/export" \
  -H "Authorization: Bearer <your-jwt-token>" \
  -H "X-App-Id: <your-app-id>" \
  -H "Content-Type: application/json" \
  -d '{"content":{"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Hello from Tiptap!"}]}]},"format":"md"}' \
  --output document.md

导出 API 头部

头部	描述
`Authorization`	`Bearer <your-jwt-token>`
`X-App-Id`	来自https://cloud.tiptap.dev/convert-settings的 Convert 应用 ID

导出 API 字段

字段	描述
`content`	Tiptap JSON 内容
`format`	目标格式，`md` 或 `gfm`，用于 GitHub 风格 Markdown