> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.thymia.ai/apollo/llms.txt.
> For full documentation content, see https://docs.thymia.ai/apollo/llms-full.txt.

# Quickstart

In this guide you will create an Apollo model run, upload two voice
recordings, and retrieve disorder and symptom scores — the complete
end-to-end flow of an Apollo integration.

<Warning>
  Apollo is a regulated medical device intended for use by qualified
  healthcare professionals only. It must not be used as a substitute
  for clinical judgement or for self-assessment.
</Warning>

## Prerequisites

* A thymia API key with Apollo access enabled. Contact
  [support@thymia.ai](mailto:support@thymia.ai) to request access.
* Two voice recordings in a supported format (FLAC, MP3, MP4, Ogg,
  WebM, or WAV), each containing at least 15 seconds of speech:
  * A **mood question recording** — the patient's spoken response to
    an open question such as "How are you feeling today?"
  * A **read-aloud recording** — the patient reading a standard
    passage aloud

## Step 1 — Create a model run

<EndpointRequestSnippet endpoint="POST /v1/models/apollo" />

<EndpointResponseSnippet endpoint="POST /v1/models/apollo" />

<Note>
  Do not use personally identifiable information such as names or
  NHS numbers as the `userLabel`. Use an anonymised reference from
  your system.
</Note>

## Step 2 — Upload both recordings

Both recordings must be uploaded before Apollo will begin processing.

**Upload the mood question recording:**

```bash
curl "https://path/to/upload/mood" \
  -X PUT \
  -H 'Content-Type: audio/mpeg' \
  --data-binary '@/path/to/mood-question.mp3'
```

**Upload the read-aloud recording:**

```bash
curl "https://path/to/upload/read" \
  -X PUT \
  -H 'Content-Type: audio/mpeg' \
  --data-binary '@/path/to/read-aloud.mp3'
```

<Warning>
  Both upload URLs are valid for 1 hour. The model will not begin
  processing until both recordings have been successfully uploaded.
</Warning>

## Step 3 — Poll for results

<EndpointRequestSnippet endpoint="GET /v1/models/apollo/{model_run_id}" />

| Status           | Meaning                                           |
| ---------------- | ------------------------------------------------- |
| `CREATED`        | Waiting for recordings to be uploaded             |
| `RUNNING`        | Both recordings uploaded, model is processing     |
| `COMPLETE_OK`    | Processing complete, results and report available |
| `COMPLETE_ERROR` | Processing failed, see `errorCode` for details    |

<EndpointResponseSnippet endpoint="GET /v1/models/apollo/{model_run_id}" />

<Warning>
  Apollo results must be reviewed and interpreted by a qualified
  healthcare professional. They must not be communicated directly
  to patients without clinical review.
</Warning>

## Next steps

* [Integration Guide](/apollo/integration-guide)
* [Interpreting Results](/apollo/interpreting-results)
* [Reports](/apollo/reports)
* [Error Reference](/apollo/error-reference)

<div>
  ***
</div>

<div>
  <img src="https://files.buildwithfern.com/https://thymia.docs.buildwithfern.com/bc677a592c05a522bf7c895b7e9f00da344a3487d5e6baf5e35f4b013bf0e0e5/docs/assets/certs/crown-commerical-logo.png" alt="Crown Commercial Service" />

  <img src="https://files.buildwithfern.com/https://thymia.docs.buildwithfern.com/0fd8cd1c5e2bf5fe9c88a9671b5d62d76ee00fff93b057d3f28295f6e74a8e54/docs/assets/certs/nhs-digital-toolkit-logo.png" alt="NHS Digital" />

  <img src="https://files.buildwithfern.com/https://thymia.docs.buildwithfern.com/3408b37c11afb0482b6108012fdea2edc6843ffa1a6a485d9440f2c28067165c/docs/assets/certs/iso-27001-logo.png" alt="ISO 27001" />

  <img src="https://files.buildwithfern.com/https://thymia.docs.buildwithfern.com/f82c2989ef0c7907f8acc1bf38c1debfb8061a0bad0fd4aff7a724794739e5b0/docs/assets/certs/iso-13485-logo.png" alt="ISO 13485" />

  <img src="https://files.buildwithfern.com/https://thymia.docs.buildwithfern.com/44816901d032fd0dc4b99030c62e6841d10b1796fde6dd1615bf23eb84f9114b/docs/assets/certs/HIPPA-logo.png" alt="HIPAA" />

  <img src="https://files.buildwithfern.com/https://thymia.docs.buildwithfern.com/1c6800dfced2f3bd97bd907302e2ae105c99ed91fd381e0cd64eef7886394779/docs/assets/certs/gdpr-logo.png" alt="GDPR" />

  <img src="https://files.buildwithfern.com/https://thymia.docs.buildwithfern.com/2276326b82aee8a143219440498266a25a1425c423a6854489e706af50d38118/docs/assets/certs/cyber-essentials-logo.png" alt="Cyber Essentials Certified" />
</div>