Tiptap Docs

Authenticate your conversion service

Available in Start planBeta

Tiptap Conversion lets you import and export Tiptap JSON to and from DOCX, PDF, ODT, EPUB, DOC, and Markdown. You can integrate import/export directly in your Tiptap editor with dedicated extensions for DOCX and Markdown, or use the Conversion REST API on your server for all supported formats.

Set up authorization

Most conversion operations require authentication. Generate a JWT (JSON Web Token) using the secret key from your Tiptap Cloud account. Include this JWT in requests or extension configs.

Export DOCX Extension

The extension-export-docx package does not require authentication! Feel free to skip these steps if you only need that extension.

  1. Activate a plan: Begin a free trial or choose a subscription.
  2. Get your App ID and secret key on the Convert settings page.
  3. Generate a JWT for testing using any JWT tool (e.g., JWT Builder). For production, always create JWTs server-side to keep your secret safe.
  4. Use the JWT in your requests or extension config. For API calls, pass it in the Authorization header and the App ID in X-App-Id.

Explore file-type integrations

Depending on which format you want to work with, each file type has its own guide covering the available REST API endpoints and, where applicable, editor extensions:

Import:

Export:

These guides explain exactly how to integrate the respective REST API endpoints into your application and configure any necessary options.

PreviouslyOverview