> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rxnote.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> The RxNote app's patient → visit → note flow, for your own software.

> [!WARNING]
>
> The RxNote API is in **private beta**. Endpoints and fields described here are v1 as it ships; ask your RxNote
> contact to enable the API for your account.

RxNote is an AI medical scribe. The API gives your system the same flow a clinician follows in the RxNote app:

1. **Create a patient** — or find one you created before.
2. **Create a visit** for the patient with a **recording** or a **transcript**.
3. **Get the result**: the transcript (with speakers and timings), a **structured note** in the template you
   choose — sections and fields with stable ids, plus display-ready HTML — and optionally a visit summary.

Patients and visits created through the API are ordinary RxNote patients and visits: the clinician can open, review
and edit them in the app under their own login.

## How it works

```mermaid theme={null}
sequenceDiagram
  participant You as Your server
  participant API as RxNote API
  You->>API: POST /patients
  API-->>You: 201 { id: 4821 }
  You->>API: POST /visits { patient_id: 4821, audio }
  API-->>You: 201 visit + upload URL
  You->>API: PUT recording to the upload URL
  You->>API: POST /visits/{id}/process
  Note over API: transcribe → note
  API-->>You: webhook visit.completed
  You->>API: GET /visits/{id}
  API-->>You: transcript + structured note
```

Already have a transcript? Send it when you create the visit instead of `audio`; there is no upload step.

> **[Quickstart](/quickstart)**
>
> Your first note in three requests.

> **[Local development](/local-development)**
>
> Run RxNote locally and call the API on localhost.

> **[Visits](/visits)**
>
> Statuses, idempotency, recordings and the note format.

> **[Webhooks](/webhooks)**
>
> Coming soon: get told when a note is ready.

## Base URLs

| Environment | Base URL | Keys |
| - | - | - |
| Production | `https://rxnote.ai/api/v1` | `rxn_live_…` |
| Sandbox | `https://dev.rxnote.ai/api/v1` | `rxn_test_…` |
| Local (RxNote engineers) | `http://localhost:3000/api/v1` | `rxn_test_…` |

Use synthetic test patients only outside production — never real patient data.


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