# RxNote API

- [Introduction](https://docs.rxnote.ai/index.md): The RxNote app's patient → visit → note flow, for your own software.
- [Quickstart](https://docs.rxnote.ai/quickstart.md): Create an API key, a patient and a visit, and read the note.
- [Authentication](https://docs.rxnote.ai/authentication.md): API keys: personal or organization, scopes, test and live.
- [Local development](https://docs.rxnote.ai/local-development.md): Run RxNote on your machine and call the API on localhost.
- [Patients](https://docs.rxnote.ai/patients.md): Create a patient once, then create visits for them.
- [Visits](https://docs.rxnote.ai/visits.md): One consultation: its statuses, idempotency, recordings, templates and the note.
- [Notes and codes](https://docs.rxnote.ai/notes.md): Regenerate a visit's note, write more notes from it, and draw its ICD codes.
- [Webhooks](https://docs.rxnote.ai/webhooks.md): Get told when a visit finishes, and verify the request came from RxNote.
- [Errors](https://docs.rxnote.ai/errors.md): One error shape, a fixed set of codes.
- [Limits](https://docs.rxnote.ai/limits.md): Request rate, visits in progress, audio and transcript size.
- [Data protection](https://docs.rxnote.ai/data-protection.md): What RxNote stores, and how patient data is handled.
- [List patients](https://docs.rxnote.ai/api-reference/patients/list-patients.md): Patients the key's clinician can see, newest first. Filter by search text, MRN or your external id. Scope `patients:read`.
- [Create a patient](https://docs.rxnote.ai/api-reference/patients/create-a-patient.md): Creates a patient, as **Add patient** does in the app, and returns its `id` for creating visits. With `external_id`, a patient that already exists for that id is returned (200) instead of a duplicate. Scope `patients:write`.
- [Get a patient](https://docs.rxnote.ai/api-reference/patients/get-a-patient.md): Scope `patients:read`.
- [List visits](https://docs.rxnote.ai/api-reference/visits/list-visits.md): Visits created with this account's keys, newest first. Scope `visits:read`.
- [Create a visit](https://docs.rxnote.ai/api-reference/visits/create-a-visit.md): Starts a consultation for a patient. With `transcript`, the note is written at once. With `audio`, the visit waits in `recording` and the response carries an `upload` URL: PUT the file there, then call process. Scope `visits:write`.
- [Process the uploaded recording](https://docs.rxnote.ai/api-reference/visits/process-the-uploaded-recording.md): Call after the audio PUT succeeds — the API's `process-audio-background`. Starts transcription and the note. Safe to repeat: a visit already processing or done is left alone. Scope `visits:write`.
- [Get a visit](https://docs.rxnote.ai/api-reference/visits/get-a-visit.md): Status, and the transcript, note and summary once ready. Poll this or use webhooks. Scope `visits:read`.
- [Regenerate the note](https://docs.rxnote.ai/api-reference/visits/regenerate-the-note.md): Writes the visit's note again from its transcript, optionally with another template — the app's regenerate. The visit goes back to `processing`; poll GET /visits/{id}. Scope `visits:write`.
- [List a visit's other notes](https://docs.rxnote.ai/api-reference/notes/list-a-visits-other-notes.md): The additional notes written from the visit, oldest first — the visit's main note is on GET /visits/{id}. Scope `visits:read`.
- [Write another note](https://docs.rxnote.ai/api-reference/notes/write-another-note.md): Writes an additional note from the visit with another template — a progress note, a referral or follow-up letter — like **+ Generate** in the app. Answers 202 with a job; poll GET /jobs/{id}. Scope `visits:write`.
- [Generate ICD codes](https://docs.rxnote.ai/api-reference/notes/generate-icd-codes.md): Draws ICD-11 diagnosis codes from the visit's note. Answers 202 with a job; poll GET /jobs/{id}. The codes also appear on GET /visits/{id}. Scope `visits:write`.
- [Get a job](https://docs.rxnote.ai/api-reference/notes/get-a-job.md): A note or ICD-code job: its status, and the note or codes once completed. Scope `visits:read`.
- [List templates](https://docs.rxnote.ai/api-reference/templates/list-templates.md): Note templates the clinician can use — the same list as the template picker in the app. Scope `templates:read`.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


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