Convert Markdown via REST API

Available in Start planBeta

Use Postman

Experiment with the Conversion API in our Postman collection.

Import API endpoint

POST /import

Converts .md files (or gfm) to 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"

Import API Headers

Header	Description
`Authorization`	`Bearer <your-jwt-token>`
`X-App-Id`	Convert App ID from https://cloud.tiptap.dev/convert-settings

Import API Fields

Field	Description
`file`	The Markdown file to convert
`imageUploadCallbackUrl`	Optional endpoint for handling images if the Markdown file references local images

Export API endpoint

POST /export

Converts Tiptap JSON to .md or .gfm.

curl -X POST "https://api.tiptap.dev/v1/convert/export" \
  -H "Authorization: Bearer <your-jwt-token>" \
  -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

Export API Headers

Header	Description
`Authorization`	`Bearer <your-jwt-token>`
`X-App-Id`	Convert App ID from https://cloud.tiptap.dev/convert-settings

Export API Fields

Field	Description
`prosemirrorJson`	Tiptap/ProseMirror JSON
`to`	Target format, `md` or `gfm` for GitHub Flavored Markdown

PreviouslyEditor extensions

Next upLegacy extensions