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

# Introduction

> Get started with the Healos External API

# Healos External API

The Healos External API lets you programmatically manage patients, documents, and appointments, and pull clinical notes out of your Healos account.

## Base URL

All API requests are made to:

```
https://api.healos.ai/ext-api/v1
```

## Quick Start

1. **Get an API key** from the Healos dashboard.
2. **Make your first request:**

```bash theme={null}
curl -H "X-API-Key: hlsk_your_key_here" \
  https://api.healos.ai/ext-api/v1/patients
```

3. **Explore the API Reference** tab for all endpoints.

## Resources

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/authentication">
    API keys, scopes, and security
  </Card>

  <Card title="Rate Limiting" icon="gauge" href="/rate-limiting">
    Request limits and best practices
  </Card>

  <Card title="Error Handling" icon="triangle-exclamation" href="/errors">
    Error response format and status codes
  </Card>
</CardGroup>

## Available Resources

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