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

# Overview

> The VitaRelay API — what it is, who it's for, and how to get started.

# Overview

The VitaRelay API is a headless interface to the VitaRelay healthcare commerce
platform. Vita Clinics use it to run the full patient → intake → order →
fulfillment loop from their own front end, and connected organizations use it to
read their orders, patients, prescriptions, and catalog.

## Base URL

```
https://vitarelay.com/api/public/v1
```

All requests must be made over HTTPS, and every request is authenticated with an
API key sent as a bearer token:

```bash theme={null}
Authorization: Bearer vr_live_xxxxxxxxxxxxxxxxxxxx
```

There is no separate sandbox host. The same base URL serves both live and test
traffic — the key you send decides which. See [Sandbox](/getting-started/sandbox).

## What you can do

| Resource          | Operations                             |
| ----------------- | -------------------------------------- |
| **Patients**      | Create (Vita Clinic), list, retrieve   |
| **Intakes**       | Submit (Vita Clinic)                   |
| **Orders**        | Create (Vita Clinic), list, retrieve   |
| **Prescriptions** | List, retrieve                         |
| **Products**      | List                                   |
| **Webhooks**      | Receive signed order and intake events |

<Note>
  Write endpoints (`POST /patients`, `POST /intakes`, `POST /orders`) are
  available to **Vita Clinics only**. The organization that owns the key must be
  an active Vita Clinic, and the key must carry the matching `:write` scope.
</Note>

All resource identifiers are UUIDs. The only exception is the sandbox, which
returns synthetic identifiers such as `sandbox_pat_…`.

## Quick example

```bash theme={null}
curl https://vitarelay.com/api/public/v1/orders \
  -H "Authorization: Bearer vr_live_xxxxxxxxxxxxxxxxxxxx"
```

## Where to go next

<CardGroup cols={2}>
  <Card title="Quickstart" href="/getting-started/quickstart">
    Run the full patient → intake → order loop against a test key in minutes.
  </Card>

  <Card title="Authentication" href="/getting-started/authentication">
    Bearer keys, scopes, and what a 401 or 403 looks like.
  </Card>

  <Card title="API Keys" href="/getting-started/api-keys">
    How VitaRelay issues your key, what it can do, and how to rotate it.
  </Card>

  <Card title="Sandbox" href="/getting-started/sandbox">
    Isolated testing with `vr_test_` keys and a simulated order lifecycle.
  </Card>

  <Card title="REST API" href="/getting-started/rest-api">
    Endpoint-by-endpoint reference with request and response shapes.
  </Card>

  <Card title="Webhooks" href="/webhooks/overview">
    Signed order and intake events delivered to your endpoint.
  </Card>
</CardGroup>