Skip to main content
Revise API reads, reviews, edits, and converts documents through a hosted REST service. Submit a job, poll its status or receive a webhook, then download the result. You can integrate it from any language; the public TypeScript client also handles uploads and polling. The production base URL is https://revise.io/api. All account endpoints below it begin with /v1 and use bearer authentication.

Make your first request

Upload Markdown, convert it to PDF, and download the result.

REST reference

Request schemas, response schemas, and examples for every endpoint.

​
Choose an operation

Prompts accept DOCX, Markdown, HTML, and plain text. Edits produce both clean and tracked-changes DOCX files. Convert PDF, images, RTF, or ODT to a supported prompt format first. Conversions can produce DOCX, PDF, Markdown, HTML, or text.

​
Before integrating

  • Access: create an API key and fund your account in the console.
  • Cost: prompts charge a request fee, tool CPU, and inference; conversions use flat or per-page pricing. See pricing and usage.
  • Models: choose managed inference or use a provider key stored on your account. See models and provider keys.
  • Limits: uploads are limited to 18 MiB and scanned PDFs to 100 pages. Jobs share your account’s queue and concurrency limits. See job lifecycle.
  • Retention: results expire 24 hours after terminal completion. Store outputs you need to keep; see files and retention and optional output encryption.
Review representative documents before adopting an automated workflow. Format conversion can change layout, and AI edits or scans can require review. The API returns completed results rather than a live token or document-edit stream. The reference covers all public account endpoints, including cancellation, continuation, usage, and webhooks. Download the OpenAPI specification to generate a client in your language.

​
TypeScript examples

The guides include HTTP examples and examples using the public @reviseio/api package. Its resource methods map to REST endpoints. Its edit and convert helpers combine upload, submission, and polling and return a lazy Source for the output.
See the TypeScript client for Source, configuration, and helper behavior. API keys belong on your server.

​
Revise Editor SDK

Revise Editor SDK embeds a collaborative editor in your application. Revise API is the hosted HTTP service described in this section. Each product has its own installation and authentication instructions. For integration questions or capacity requirements, contact support@revise.io. For an existing request, include its job ID, error code, and approximate UTC time. Keep API keys out of support messages.