# Orkero API

> Booking, patient feedback and the phone agent for healthcare practices, on one compliant patient database.

Source: https://docs.orkero.app/

Orkero runs healthcare practices: the diary, records of care, the till, recalls and the
phones. The API lets your software use the same building blocks, with the hard healthcare
parts already done: consent, audit trails, UK GDPR, and data kept in the UK.

## What you can build today

| Building block | What it does | Status |
| --- | --- | --- |
| [Booking](/quickstart/booking) | Show a practice's free times, book, move and cancel, and hear when a patient changes a booking. | Live |
| [Feedback](/quickstart/feedback) | Tell us a visit is done; we ask the patient one question and give you the practice's Net Promoter Score. | Live |
| [Voice](/quickstart/voice) | Give a practice an AI receptionist that answers calls, books and hands over to a person. | Early access |
| [Accounts](/reference/accounts) | Each day's takings, VAT and payroll hours, for a ledger. | Live |

## How it works

- **REST and JSON**, described by one [OpenAPI file](/openapi.yaml) that this site, our code
  library and our AI tools are all built from.
- **Signed webhooks** tell you what happened, so you do not have to keep asking. See
  [Webhooks](/webhooks).
- **Test keys** behave exactly like live ones, but nothing is kept, booked or sent. See
  [Keys and requests](/keys).
- **Rules you cannot switch off**: a patient who says "don't ask me again" is never asked
  again; a booking is only ever made at a time the practice's own diary offers; nothing
  about a patient leaves the practice except what a request needs.

## Start in five minutes

1. Ask for early access and you will be sent a **test key**.
2. Check it works:

```bash
curl https://api.orkero.app/v1/ping \
  -H "Authorization: Bearer $ORKERO_KEY"
```

3. Follow a quickstart: [Booking](/quickstart/booking), [Feedback](/quickstart/feedback)
   or [Voice](/quickstart/voice).

## Using an AI assistant?

Every page here is also plain text. Press **Copy for AI** at the top of any page, or point
your assistant at [/llms.txt](/llms.txt) (an index) or [/llms-full.txt](/llms-full.txt)
(everything in one file). See [Orkero and AI tools](/ai).
