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

# Introduction

> A real word processor, embedded in your React application.

The [Revise Editor SDK](https://revise.io/sdk) is a browser-only React component that puts a full word
processor inside an application that already owns its shell, authentication,
storage, and users.

Your application hands the SDK a document — `.docx`, Markdown, plain text, or
HTML — and gets a `.docx` back. In between, the component:

* parses the file with Revise's own converters, preserving comments and
  tracked changes on the DOCX path;
* creates a [Yjs](https://yjs.dev)-backed editing session — every document is
  a CRDT, so real-time collaboration over a transport you own is the native
  state, not an add-on;
* renders the document on canvas, paginated, with the native ribbon (or none at
  all, if you would rather build your own);
* preserves comments and tracked changes through the round trip;
* exposes Revise's canonical document-local JSON-schema tools, so whatever
  model you already run can read and edit the document;
* exports back to `.docx`.

A second entry point, `@reviseio/sdk/backend`, runs the same converters and
document-local semantic tools under Node — and it is the half no other DOCX
SDK offers. Your server becomes a first-class participant in the same
collaborative documents: create rooms before anyone opens them, edit live
documents headlessly, propose tracked changes a user reviews in the browser,
and export Word again — all against a host-owned Y.Doc, with no React mount
and no model required. Browser and server speak one tool contract, so host
code is shared verbatim between them. See
[collaboration](/editor-sdk/guides/collaboration#your-server-is-a-participant) and the
[backend reference](/editor-sdk/api/backend).

## What it is not

The SDK deliberately 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 wire up
an agent yourself.

<Note>
  Multi-user editing works, but the transport is yours. Pass a Yjs provider —
  Hocuspocus, y-websocket, or your own — and the document becomes
  collaborative, with remote carets and presence. The SDK never opens a
  connection or stores anything. See
  [collaboration](/editor-sdk/guides/collaboration) and [roles](/editor-sdk/guides/roles). There is
  no document locking, and roles are client-side boundaries rather than a
  server-enforced permission model.
</Note>

<Note>
  The SDK is proprietary software available under a commercial licence. Email
  [sdk@revise.io](mailto:sdk@revise.io?subject=Revise%20Editor%20SDK%20inquiry) for
  access to the package.
</Note>

## Two audiences, two API surfaces

The SDK is designed for two consumers at once, and keeping them straight is the
single most useful idea in these docs.

<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](/editor-sdk/api/handle).
  </Card>

  <Card title="Your agent" icon="robot">
    JSON-schema tools with serializable inputs and outputs, operating on
    semantic document state rather than UI geometry. Safe to invoke without
    React state or browser focus. See [agent tools](/editor-sdk/guides/agent-tools).
  </Card>
</CardGroup>

Capabilities deliberately overlap — selection, for instance, exists on both
surfaces — but the shapes differ, because a React panel and a language model
want different things. Interactive concerns such as review navigation and
comment-panel state are host-only by design; agents get semantic mutation tools
instead.

## Where it fits

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

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

  <Card title="Review products" icon="user-check">
    Where every change has to be attributable and reversible.
  </Card>

  <Card title="Document-heavy SaaS" icon="file-lines">
    Anything that currently ends in "download the .docx".
  </Card>
</CardGroup>

Start with the [quickstart](/editor-sdk/quickstart), then read
[architecture](/editor-sdk/concepts/architecture) to understand what the component owns
and what you own.