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

# API Reference

> Full endpoint listing with request and response schemas

# API Reference

Every endpoint, with request and response schemas and a live "Try it" playground,
is listed in the **Endpoints** section of this tab's sidebar.

## Basics

* **Base URL**: `https://api.healos.ai/ext-api/v1`
* **Auth**: send your key as `X-API-Key: hlsk_...` on every request — see [Authentication](/authentication).
* **Shape**: success responses are `{ "data": ... }`; list endpoints add a `meta`
  block. Errors are `{ "error": ... }`. See [Making Requests](/making-requests)
  and [Error Handling](/errors).

## Resources

| Resource         | Description                                                                                                                       |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| **Patients**     | Create, read, update, and delete patient records                                                                                  |
| **Documents**    | Upload, list, and delete patient documents                                                                                        |
| **Appointments** | Manage appointments with scheduling, recurrence, and status                                                                       |
| **Notes**        | Read clinical notes with transcript, codes, and patient context — see the [Clinical Notes guide](/clinical-notes) for bulk export |

<Note>
  The bulk export endpoint (`GET /notes/export`, with `format=json|csv|ndjson`)
  is documented in the [Clinical Notes guide](/clinical-notes), not in the
  endpoint playground.
</Note>