For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact us
OverviewHeliosApolloSentinelAPI ReferenceChangelog
OverviewHeliosApolloSentinelAPI ReferenceChangelog
    • Introduction
  • thymia API
Contact us
Logo
On this page
  • Base URL
  • Authentication
  • Making your first request
  • Request and response format
  • HTTP status codes
  • SDKs
  • Endpoints

Introduction

Explore the thymia API reference with comprehensive guides, code examples, and endpoint documentation.
||View as Markdown|

Last updated March 26, 2026

Next

Run the model on an existing recording

Built with

Base URL

$https://api.thymia.ai
RegionBase URL
Defaulthttps://api.thymia.ai
Canadahttps://ca.api.thymia.ai
United Stateshttps://us.api.thymia.ai

Authentication

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

$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 immediately if your key is compromised.

Making your first request

GET
/v1/account
1curl /v1/account \
2 -H "x-api-key: <apiKey>" \
3 -H "Content-Type: application/json"
Try it
Response
1{
2 "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3 "features": [
4 "data-export",
5 "real-time-analytics",
6 "user-management"
7 ]
8}

Request and response format

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

$YYYY-MM-DDTHH:MM:SS+HH:MM

HTTP status codes

Status codeMeaning
200Request succeeded
401Unauthorized — missing or invalid API key
404Not found — resource does not exist or has been deleted
422Unprocessable 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

Helios

Create model runs, upload recordings, retrieve biomarker results.

Apollo

Create model runs, upload recordings, retrieve disorder and symptom scores.

Sentinel

Real-time voice safety and wellbeing monitoring SDK.

Questionnaires

Create questionnaires, retrieve responses and scores.

User Data

Upload JSON data gathered about a specific user.

Account

Retrieve account details and enabled features.


Crown Commercial ServiceNHS DigitalISO 27001ISO 13485HIPAAGDPRCyber Essentials Certified