Tiptap Docs

AI Toolkit

Business planBeta

The AI Toolkit is a set of tools that enables your AI to work with Tiptap documents.

Use it to build AI agents with document-editing superpowers. Or add custom AI functionality to the Tiptap editor with its flexible primitives.

Integrate the AI Toolkit with expert support

We're onboarding Enterprise teams building custom AI agents and extensions with the AI Toolkit. Get direct engineering support and shape the product roadmap.

On a different plan? Join the waitlist

Talk to an engineer

Trusted by Axios, PostHog, Beehiiv, GitLab and more.

Features

  • AI agent tools: Add document-editing tools to your AI agent
  • Primitives: Utils to build custom AI tools and extensions
    • Read documents: Get the document's content in a AI-compatible format
    • Edit documents: Let AI make precise edits to the document
    • Schema awareness: Inform the AI model about the document's structure
    • Display suggestions: Let users review AI-generated content
    • Compare documents in real-time and show a diff view

Installation guide

The AI Toolkit is currently in closed access. We onboard customers individually to ensure the best setup. Request access here.

Once granted access, configure your package manager by following the private registry guide.

Then, install the package:

npm install @tiptap-pro/ai-toolkit

Add the extension to your editor and access its methods:

import { Editor } from '@tiptap/core'
import StarterKit from '@tiptap/starter-kit'
import { AiToolkit, getAiToolkit } from '@tiptap-pro/ai-toolkit'

const editor = new Editor({
  extensions: [StarterKit, AiToolkit],
})

// Get the AI Toolkit instance
const toolkit = getAiToolkit(editor)

// Call the AI Toolkit methods
toolkit.insertText('AI-generated content')

Next steps

New to the AI Toolkit? Begin with the quickstart guides:

Or explore the advanced guides:

Migrating from another AI extension?

Read the migration guides to replace other Tiptap AI extensions with the AI Toolkit.

API reference

The AI Toolkit is split into packages and modules:

PreviouslyAI Toolkit