Tiptap Editor 3.0 Beta is out. Start here

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

HeaderDescription
AuthorizationBearer <your-jwt-token>
X-App-IdConvert App ID from https://cloud.tiptap.dev/convert-settings

Import API Fields

FieldDescription
fileThe markdown file to convert
imageUploadCallbackUrlOptional 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>" \
  -H "Content-Type: application/json" \
  -d '{"content":{"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Hello from Tiptap!"}]}]},"format":"md"}' \
  --output document.md

Export API Headers

HeaderDescription
AuthorizationBearer <your-jwt-token>
X-App-IdConvert App ID from https://cloud.tiptap.dev/convert-settings

Export API Fields

FieldDescription
contentTiptap JSON content
formatTarget format, md or gfm for GitHub Flavored Markdown