---
title: "API Reference"
description: "Complete API reference for the AI Toolkit methods."
canonical_url: "https://tiptap.dev/docs/content-ai/capabilities/ai-toolkit/api-reference"
---

# API Reference

Complete API reference for the AI Toolkit methods.

The AI Toolkit provides a set of methods that are the building blocks for your AI integrations. You can call these methods from the AI Tolkit instance:

```ts
import { Editor } from '@tiptap/core'
import { AiToolkit, getAiToolkit } from '@tiptap-pro/ai-toolkit'

// Get the AI Toolkit instance
const editor = new Editor({ extensions: [AiToolkit] })
const toolkit = getAiToolkit(editor)

// Call an AI Toolkit method
const text = toolkit.getTextRange({ from: 0, to: 100 })
```

Below is a list of the available methods:

[Read the document
More →Extract document content in JSON, HTML, or text formats with support for selections, ranges,
and chunked reads.](https://tiptap.dev/docs/content-ai/capabilities/ai-toolkit/api-reference/read-the-document.md)

[Edit the document
More →Insert, stream, and patch AI-generated content in text, HTML, or JSON formats with review
options.](https://tiptap.dev/docs/content-ai/capabilities/ai-toolkit/api-reference/edit-the-document.md)

[Execute tool
More →Execute AI agent tool calls against a Tiptap editor using the AI Toolkit.](https://tiptap.dev/docs/content-ai/capabilities/ai-toolkit/api-reference/execute-tool.md)

[Workflows
More →API reference for the built-in workflows of the AI Toolkit.](https://tiptap.dev/docs/content-ai/capabilities/ai-toolkit/api-reference/workflows.md)

[Suggestions
More →Manage and render AI suggestions with preview and review modes.](https://tiptap.dev/docs/content-ai/capabilities/ai-toolkit/api-reference/suggestions.md)

[Schema awareness
More →Provide schema awareness to AI models so they understand nodes, marks, and attributes.](https://tiptap.dev/docs/content-ai/capabilities/ai-toolkit/api-reference/schema-awareness.md)

[Diff utility
More →Compute changes between two documents programmatically.](https://tiptap.dev/docs/content-ai/capabilities/ai-toolkit/api-reference/diff-utility.md)

[Split view
More →API reference for createSplitView and the SplitView instance methods.](https://tiptap.dev/docs/content-ai/capabilities/ai-toolkit/api-reference/split-view.md)