Install

Set up credentials and install the conversion extensions for your project.

Prerequisites

1. Start a free trial or choose a subscription.
2. Set up access to Tiptap's private npm registry.

Authentication

Most conversion extensions and REST API endpoints require a JWT for authentication. The DOCX export extension is the exception and works without credentials.

1. Go to the Convert settings page in your Tiptap Cloud account.
2. Copy your App ID and secret key.
3. Generate a JWT using any JWT tool (e.g., JWT Builder) for local testing. In production, always generate JWTs server-side to keep your secret safe.

You will pass the JWT and App ID when configuring extensions or making REST API calls. See the format-specific setup guides below for details.

Install packages

Install the extensions you need for the formats you want to support.

Import:

# DOCX import (editor extension)
npm install @tiptap-pro/extension-import-docx

Export:

# DOCX export (editor extension, no auth required)
npm install @tiptap-pro/extension-export-docx

# PDF export
npm install @tiptap-pro/extension-export-pdf

# ODT export
npm install @tiptap-pro/extension-export-odt

# EPUB export
npm install @tiptap-pro/extension-export-epub

# Markdown export
npm install @tiptap-pro/extension-export-markdown

Next steps

Choose your format in the sidebar to see the full setup and configuration guide for each extension and REST API.