Tiptap 中文文档

通过 REST API 转换 Markdown（旧版）

Deprecated

旧版 Markdown REST API（已弃用）

此 REST API 已弃用，并将在 2026 年的某个时间点停止服务，团队会提前通知。对于新的集成，请使用更新后的 Markdown 导出 REST API 和 Markdown 导入 REST API。

使用 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>" \
  -H "X-App-Id: <your-app-id>" \
  -F "file=@/path/to/file.md"

导入 API 头部

头部描述
AuthorizationBearer <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>" \
  -H "X-App-Id: <your-app-id>" \
  -F 'prosemirrorJson={"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Hello from Tiptap!"}]}]}' \
  -F 'to=md' \
  --output document.md

导出 API 头部

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

导出 API 字段

字段描述
prosemirrorJsonTiptap/ProseMirror JSON
to目标格式，md 或 gfm，用于 GitHub 风格 Markdown
PreviouslyMarkdown（旧版）