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

# Introduction

## Base URL

```bash
https://api.thymia.ai
```

| Region        | Base URL                   |
| ------------- | -------------------------- |
| Default       | `https://api.thymia.ai`    |
| Canada        | `https://ca.api.thymia.ai` |
| United States | `https://us.api.thymia.ai` |

## Authentication

All requests must include your API key in the `x-api-key` header:

```bash
x-api-key: YOUR_API_KEY
```

**Your API key is a secret.** Do not share it or expose it in
client-side code. Contact
[support@thymia.ai](mailto:support@thymia.ai) immediately if your
key is compromised.

### Making your first request

<EndpointRequestSnippet endpoint="GET /v1/account" />

<EndpointResponseSnippet endpoint="GET /v1/account" />

## Request and response format

All request and response bodies use JSON. Timestamps use ISO 8601
format unless stated otherwise:

```bash
YYYY-MM-DDTHH:MM:SS+HH:MM
```

## HTTP status codes

| Status code | Meaning                                                 |
| ----------- | ------------------------------------------------------- |
| `200`       | Request succeeded                                       |
| `401`       | Unauthorized — missing or invalid API key               |
| `404`       | Not found — resource does not exist or has been deleted |
| `422`       | Unprocessable entity — request body is malformed        |

## SDKs

Official SDKs are coming soon. The thymia API can be called from
any language or framework that supports HTTP requests.

## Endpoints

<CardGroup cols={2}>
  <Card title="Helios" href="/api-reference/helios">
    Create model runs, upload recordings, retrieve biomarker results.
  </Card>

  <Card title="Apollo" href="/api-reference/apollo">
    Create model runs, upload recordings, retrieve disorder and
    symptom scores.
  </Card>

  <Card title="Sentinel" href="/sentinel/overview">
    Real-time voice safety and wellbeing monitoring SDK.
  </Card>

  <Card title="Questionnaires" href="/api-reference/questionnaires">
    Create questionnaires, retrieve responses and scores.
  </Card>

  <Card title="User Data" href="/api-reference/user-data">
    Upload JSON data gathered about a specific user.
  </Card>

  <Card title="Account" href="/api-reference/account">
    Retrieve account details and enabled features.
  </Card>
</CardGroup>

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