> ## Documentation Index
> Fetch the complete documentation index at: https://revise.io/developer/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> A word processor component for React applications.

The [Revise Editor SDK](https://revise.io/sdk) is a browser-only React component
that embeds a word processor in your application. Your application keeps its
own shell, authentication, storage, and users.

You give the SDK a document (`.docx`, `.odt`, `.rtf`, Markdown, plain text, or
HTML) and get a `.docx` back. The component:

* parses the file with Revise's converters, keeping comments and tracked
  changes on the DOCX path;
* opens a [Yjs](https://yjs.dev)-backed editing session. Every document is a
  CRDT, so real-time collaboration over your own transport needs no extra
  setup;
* renders the document on canvas with pagination, with the built-in ribbon or
  your own toolbar;
* keeps comments and tracked changes through the round trip;
* exposes Revise's document-local JSON-schema tools, so the model you already
  run can read and edit the document;
* exports to `.docx`.

A second entry point, `@reviseio/editor/server`, runs the same converters and
document-local semantic tools in Node. Your server can join the same
collaborative documents: create rooms before anyone opens them, edit live
documents headlessly, propose tracked changes for a user to review in the
browser, and export to Word. All of this works on a host-owned Y.Doc, with no
React mount and no model. Browser and server use one tool contract, so host
code runs unchanged in both. See
[collaboration](/developer/docs/developer/docs/editor-sdk/guides/collaboration#server-editing) and the
[backend reference](/developer/docs/developer/docs/editor-sdk/api/backend).

## What it does not include

The SDK does not provide accounts, authentication, document storage,
collaboration servers, tenancy, billing, or an application shell. It is a
component, not a platform. Nothing leaves the browser unless you connect an
agent.

<Note>
  For multi-user editing, pass a Yjs provider (Hocuspocus, y-websocket, or your
  own). The document then shows remote carets and presence. The SDK never
  opens a connection or stores anything. There is no document locking, and
  roles are enforced on the client, not the server. See
  [collaboration](/developer/docs/developer/docs/editor-sdk/guides/collaboration) and [roles](/developer/docs/developer/docs/editor-sdk/guides/roles).
</Note>

<Note>
  Install it with `npm i @reviseio/editor`. The SDK is closed-source and free for
  evaluation, personal projects, and education. Production use by businesses,
  nonprofits, and government requires a [license](/developer/docs/developer/docs/editor-sdk/license).
</Note>

## Two API surfaces

The SDK has one API for your application and one for your agent.

<CardGroup cols={2}>
  <Card title="Your application" icon="react">
    Component props, callbacks, and the typed controllers on
    `ReviseEditorHandle`. Subscriptions, focus management, `File` and `Blob`
    objects, custom toolbars and panels. See the [handle
    reference](/developer/docs/developer/docs/editor-sdk/api/handle).
  </Card>

  <Card title="Your agent" icon="robot">
    JSON-schema tools with serializable inputs and outputs. They operate on
    semantic document state, not UI geometry, and run without React state or
    browser focus. See [agent tools](/developer/docs/developer/docs/editor-sdk/guides/agent-tools).
  </Card>
</CardGroup>

Some capabilities exist on both surfaces, such as selection, with different
shapes for each. Interactive state such as review navigation and the comment
panel is host-only. Agents get semantic mutation tools instead.

## Use cases

<CardGroup cols={2}>
  <Card title="AI copilots" icon="wand-magic-sparkles">
    Products that edit contracts, not only render them.
  </Card>

  <Card title="Vertical workflow apps" icon="diagram-project">
    Apps that replace a round trip through Microsoft Word.
  </Card>

  <Card title="Review products" icon="user-check">
    Products where every change must be attributable and reversible.
  </Card>

  <Card title="Document-heavy SaaS" icon="file-lines">
    Products whose workflow ends in "download the .docx".
  </Card>
</CardGroup>

Start with the [quickstart](/developer/docs/developer/docs/editor-sdk/quickstart). Then read
[architecture](/developer/docs/developer/docs/editor-sdk/concepts/architecture) for what the component owns
and what you own.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.