# Revise Developer Platform > Documentation for revise (the CLI and TypeScript library), the Revise Editor SDK, and the Revise API. Every page is also available as Markdown: add .md to its URL. All pages in one file: https://revise.io/developer/docs/llms-full.txt ## Start here - [Revise Developer Platform](https://revise.io/developer/docs/index.md): Build document workflows with Revise CLI, Revise API, and Revise Editor SDK. - [Build with AI](https://revise.io/developer/docs/build-with-ai.md): Agent skills, plugins, and machine-readable docs for coding agents working with Revise. ## Revise CLI Edit and convert Word documents headlessly ### Getting started - [Overview](https://revise.io/developer/docs/revise/introduction.md): Read, edit, and redline Word documents from the command line or TypeScript. - [Build with AI](https://revise.io/developer/docs/build-with-ai.md): Agent skills, plugins, and machine-readable docs for coding agents working with Revise. - [Changelog](https://revise.io/developer/docs/revise/changelog.md): Release history for revise, the CLI and TypeScript library. ### Guides - [Revise CLI](https://revise.io/developer/docs/revise/cli.md) - [JSON output](https://revise.io/developer/docs/revise/json.md): The --json contract: one envelope for every command. - [Library](https://revise.io/developer/docs/revise/library.md): ReviseDocument: open, read, edit, review, and export documents from Node. - [Agents](https://revise.io/developer/docs/revise/agents.md): Give a model Revise's editing tools, or teach a coding agent the CLI. - [Collaboration](https://revise.io/developer/docs/revise/collaboration.md): Seed, edit, and export live Yjs rooms that browsers are editing. ## Revise Editor SDK A fast, agent-friendly word processor for your app ### Getting started - [Introduction](https://revise.io/developer/docs/editor-sdk/introduction.md): A word processor component for React applications. - [Installation](https://revise.io/developer/docs/editor-sdk/installation.md): Install from npm. Free for evaluation, personal projects, and education. - [Quickstart](https://revise.io/developer/docs/editor-sdk/quickstart.md): Render a document in about ten lines. - [Licensing](https://revise.io/developer/docs/editor-sdk/license.md): Free for noncommercial use, education, and evaluation. A commercial license for production use by organizations. - [Architecture](https://revise.io/developer/docs/editor-sdk/concepts/architecture.md): What the component owns, what you own, and how state is scoped. - [Changelog](https://revise.io/developer/docs/editor-sdk/changelog.md): Release history for @reviseio/editor (formerly revise and @reviseio/sdk). - [Support](https://revise.io/developer/docs/editor-sdk/support.md): How to report a problem, and what to send with it. ### Guides - [Documents](https://revise.io/developer/docs/editor-sdk/guides/documents.md): Opening, switching, and closing documents in a multi-document workspace. - [Input formats](https://revise.io/developer/docs/editor-sdk/guides/formats.md): Import DOCX, ODT, RTF, Markdown, plain text, and HTML. Export DOCX, PDF, HTML, Markdown, and text. - [Chrome and toolbars](https://revise.io/developer/docs/editor-sdk/guides/chrome.md): Use the built-in ribbon or build your own toolbar. - [Appearance](https://revise.io/developer/docs/editor-sdk/guides/appearance.md): Theme, colors, fonts, and zoom. - [Tracked changes](https://revise.io/developer/docs/editor-sdk/guides/tracked-changes.md): Suggestions your users can accept or reject, from people and agents alike. - [Roles and permissions](https://revise.io/developer/docs/editor-sdk/guides/roles.md): What a participant is allowed to do, enforced everywhere. - [Comments](https://revise.io/developer/docs/editor-sdk/guides/comments.md): Threads anchored to text, from your UI or your agent. - [Collaboration](https://revise.io/developer/docs/editor-sdk/guides/collaboration.md): Real-time multi-user editing over your own transport, with your server as a participant. - [Selection](https://revise.io/developer/docs/editor-sdk/guides/selection.md): Read the selection, and keep it while your own UI takes focus. - [Tools for your agent](https://revise.io/developer/docs/editor-sdk/guides/agent-tools.md): Hand the document to whatever model you already run. - [Delegate to the Revise agent](https://revise.io/developer/docs/editor-sdk/guides/delegated-agent.md): Run a whole task with the Revise multi-turn agent. ### API reference - [](https://revise.io/developer/docs/editor-sdk/api/revise-editor.md): Every prop on the editor component. - [ReviseEditorHandle](https://revise.io/developer/docs/editor-sdk/api/handle.md): The controllers your application drives the editor with. - [Server-side work](https://revise.io/developer/docs/editor-sdk/api/backend.md): Convert, edit, and export documents in Node with revise. - [Agent tool reference](https://revise.io/developer/docs/editor-sdk/api/agent-tools.md): The document-local tools the SDK exposes to a model. - [Types](https://revise.io/developer/docs/editor-sdk/api/types.md): The exported TypeScript surface. ## Revise API Edit and convert documents with our infrastructure ### Getting started - [Revise API](https://revise.io/developer/docs/revise-api/introduction.md): Edit and convert documents through a REST API. - [Authentication](https://revise.io/developer/docs/revise-api/authentication.md): Authenticate REST requests with a Revise API key. - [REST quickstart](https://revise.io/developer/docs/revise-api/quickstart.md): Upload a document, submit a conversion, and retrieve the PDF. - [Pricing and usage](https://revise.io/developer/docs/revise-api/pricing.md): Understand charges, account credit, and usage reports. ### Guides - [Prompts and document edits](https://revise.io/developer/docs/revise-api/prompts.md): Read, review, and edit documents, with clean and tracked DOCX output. - [File conversions](https://revise.io/developer/docs/revise-api/conversions.md): Convert document formats or reconstruct editable content from PDFs and images. - [Models and provider keys](https://revise.io/developer/docs/revise-api/models.md): Choose a model and decide who bills its inference. - [Files, artifacts, and retention](https://revise.io/developer/docs/revise-api/files.md): Manage uploaded inputs, verified outputs, and content lifetime. - [Job lifecycle and limits](https://revise.io/developer/docs/revise-api/jobs.md): Poll, cancel, and resume work, and control execution budgets. - [Errors, idempotency, and retries](https://revise.io/developer/docs/revise-api/errors.md): Recover interrupted work without submitting a duplicate job. - [Output encryption](https://revise.io/developer/docs/revise-api/encryption.md): Request authenticated JWE ciphertext for document artifacts. - [Webhooks](https://revise.io/developer/docs/revise-api/webhooks.md): Receive, verify, and acknowledge job status notifications. - [TypeScript client](https://revise.io/developer/docs/revise-api/typescript.md): Use @reviseio/api for typed REST calls and document workflows. ### REST reference #### Prompts - [Create a prompt](https://revise.io/developer/docs/revise-api/reference/create-prompt.md): Submit a text request or read, comment on, or edit one document. - [Get a prompt](https://revise.io/developer/docs/revise-api/reference/get-prompt.md): Read status, receipt, and unexpired result. - [Cancel a prompt](https://revise.io/developer/docs/revise-api/reference/cancel-prompt.md): Send no body. - [Resume a prompt](https://revise.io/developer/docs/revise-api/reference/resume-prompt.md): Resume a paused prompt with new absolute cost limits. - [List prompts](https://revise.io/developer/docs/revise-api/reference/list-prompts.md): Returns Prompt receipts newest first, ordered by created_at then ID. - [Delete prompt content](https://revise.io/developer/docs/revise-api/reference/delete-prompt-content.md): Send no body. #### Conversions - [List conversions](https://revise.io/developer/docs/revise-api/reference/list-conversions.md): Newest first, ordered by creation time then ID. - [Create a conversion](https://revise.io/developer/docs/revise-api/reference/create-conversion.md): Convert one uploaded file to docx, pdf, md, html, or txt. - [Get a conversion](https://revise.io/developer/docs/revise-api/reference/get-conversion.md): Read conversion status, receipt, and output artifact. - [Cancel a conversion](https://revise.io/developer/docs/revise-api/reference/cancel-conversion.md): Send no body. - [Delete conversion content](https://revise.io/developer/docs/revise-api/reference/delete-conversion-content.md): Send no body. #### Files - [Upload a file](https://revise.io/developer/docs/revise-api/reference/upload-file.md): Upload one nonempty file with a supported extension: DOCX, MD/Markdown, HTML/HTM, TXT, RTF, ODT, PDF, JPEG/JPG, PNG, WebP, or GIF. - [Get file metadata](https://revise.io/developer/docs/revise-api/reference/get-file.md): Read uploaded source metadata. - [Delete a file](https://revise.io/developer/docs/revise-api/reference/delete-file.md): Delete an uploaded file; rejects active use with 409. #### Artifacts - [Get artifact metadata](https://revise.io/developer/docs/revise-api/reference/get-artifact.md): Read metadata for an immutable output variant. - [Download artifact content](https://revise.io/developer/docs/revise-api/reference/download-artifact.md): Returns artifact bytes directly or a 302 redirect to a signed storage URL valid for five minutes. #### Account - [Get account](https://revise.io/developer/docs/revise-api/reference/get-account.md): Read the account credit balance. - [Get account ledger](https://revise.io/developer/docs/revise-api/reference/get-ledger.md): Latest 50 entries with no pagination. - [Get a top-up](https://revise.io/developer/docs/revise-api/reference/get-topup.md): Read an existing funding order. #### Models - [List models](https://revise.io/developer/docs/revise-api/reference/list-models.md): Return supported prompt model IDs and defaults without consuming inference or credit. #### Usage - [Get usage](https://revise.io/developer/docs/revise-api/reference/get-usage.md): Aggregate settled prompts and conversions by completion time. #### Webhooks - [Create a webhook](https://revise.io/developer/docs/revise-api/reference/create-webhook.md): Register up to 10 active account-wide endpoints. - [List webhooks](https://revise.io/developer/docs/revise-api/reference/list-webhooks.md): List active webhook endpoints (no signing secrets). - [Delete a webhook](https://revise.io/developer/docs/revise-api/reference/delete-webhook.md): Disable endpoint and cancel pending deliveries. - [List webhook deliveries](https://revise.io/developer/docs/revise-api/reference/list-webhook-deliveries.md): Newest first, scoped cursor. - [Retry a webhook delivery](https://revise.io/developer/docs/revise-api/reference/retry-webhook-delivery.md): Send no body.