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

# Revise API

> Edit and convert documents through a REST API.

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.

<CardGroup cols={2}>
  <Card title="Make your first request" icon="rocket" href="/revise-api/quickstart">Upload Markdown, convert it to PDF, and download the result.</Card>
  <Card title="REST reference" icon="code" href="/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                        |

The reference also covers request history, cancellation, prompt resumption, content deletion, account information, usage, models, and webhooks. Download the [OpenAPI specification](https://revise.io/api/v1/openapi.json) 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.

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

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

## Revise Editor SDK

[Revise Editor SDK](/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.