> ## 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.

# Revise API

> Edit and convert documents through a REST API.

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. It works from any language. The 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.

<CardGroup cols={2}>
  <Card title="Make your first request" icon="rocket" href="/developer/docs/developer/docs/revise-api/quickstart">Upload Markdown, convert it to PDF, and download the result.</Card>
  <Card title="REST reference" icon="code" href="/developer/docs/developer/docs/revise-api/reference/create-prompt">Request schemas, response schemas, and examples for every endpoint.</Card>
</CardGroup>

## Choose an operation

| Task | Endpoint | Result |
| - | - | - |
| Ask a question, edit text, or review a document | `POST /v1/prompt` | Prompt receipt, assistant response, and document artifacts when requested |
| Convert a document | `POST /v1/convert` | Conversion receipt and an output artifact |
| Supply a document | `POST /v1/files` | Uploaded file ID |
| Retrieve finished output | `GET /v1/artifacts/{id}/content` | File bytes, or JWE ciphertext for encrypted output |

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](/developer/docs/developer/docs/revise-api/conversions) can produce DOCX, PDF, Markdown, HTML, or text.

## Requirements

* **Access:** create an [API key](/developer/docs/developer/docs/revise-api/authentication) and fund your account in the [console](https://revise.io/console).
* **Cost:** prompts charge a request fee, tool CPU, and inference; conversions use flat or per-page pricing. See [pricing and usage](/developer/docs/developer/docs/revise-api/pricing).
* **Models:** choose managed inference or use a provider key stored on your account. See [models and provider keys](/developer/docs/developer/docs/revise-api/models).
* **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](/developer/docs/developer/docs/revise-api/jobs).
* **Retention:** results expire 24 hours after terminal completion. Store outputs you need to keep; see [files and retention](/developer/docs/developer/docs/revise-api/files) and optional [output encryption](/developer/docs/developer/docs/revise-api/encryption).

The API returns finished results. It does not stream tokens or document edits.

The reference covers every public account endpoint, including cancellation, continuation, usage, and webhooks. Download the [OpenAPI specification](https://revise.io/api/v1/openapi.json) to generate a client in your language.

## TypeScript client

The guides show HTTP examples and examples for the `@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.

```bash theme={null}
npm install @reviseio/api
```

See [the TypeScript client](/developer/docs/developer/docs/revise-api/typescript) for `Source`, configuration, and helper behavior. API keys belong on your server.

## Revise Editor SDK

[Revise Editor SDK](/developer/docs/developer/docs/editor-sdk/introduction) 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.

## Support

For integration questions or capacity requirements, contact [support@revise.io](mailto:support@revise.io). For a specific request, include its job ID, error code, and approximate UTC time. Don't include API keys.


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