Skip to main content
Revise API processes documents on your behalf. Submit a prompt to read, comment on, or edit a document, or submit a conversion to change its format. Requests run asynchronously and return receipts you can poll. Completed requests expose downloadable artifacts. 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

The reference also covers request history, cancellation, prompt resumption, content deletion, account information, usage, models, 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.