# Sonde Health

> Sonde Health turns short voice samples into vocal biomarkers — objective, AI-derived
> measures of respiratory, mental and cognitive fitness. Partners integrate through the
> Sonde Platform Service API (REST/JSON on https://api.sondeservices.com, OAuth 2.0
> client-credentials) or through on-device Passive, Cued and Edge SDKs for Android and
> iOS. Access is partner-only: credentials and scopes are allocated under contract,
> there is no self-service signup, and there is no published pricing.

Generated by API Evangelist on 2026-08-28 from Sonde Health's public documentation.
This file is NOT published by Sonde Health.

## What the API does

Register a subject, request a signed URL, upload a WAV voice sample, create an inference
job, poll for the score. Measures available: Respiratory Symptoms Risk (a held 6-second
"ahh"), Mental Fitness voice features (30 seconds of free speech, returning Smoothness,
Control, Liveliness, Energy Range, Clarity, Crispness, Speech Rate and Pause Duration
plus an aggregate), M3 and PHQ-2 questionnaire scores, and English transcription
(Journaling).

## Base URL and auth

- Base URL: https://api.sondeservices.com
- Token endpoint: POST /platform/v1/oauth2/token (Screening API: /platform/api/v1/oauth2/token)
- Grant: client_credentials, Basic base64(client-id:client-secret), form-encoded body
- Token: Bearer, expires_in 3600
- Scopes: sonde-platform/<resource>.<verb> — 17 published, allocated per contract

## Documentation

- Developer landing: https://www.sondehealth.com/dev-documentation
- Platform documentation: https://sondehealth.atlassian.net/wiki/spaces/SA/overview
- REST API Reference: https://sondehealth.atlassian.net/wiki/spaces/SA/pages/2689105939/REST+API+Reference
- Getting Started (Cloud API): https://sondehealth.atlassian.net/wiki/spaces/SA/pages/2800156688/Getting+Started%3A+Sonde+Cloud+API
- Authentication scopes: https://sondehealth.atlassian.net/wiki/spaces/SA/pages/2706931713/Authentication+Scopes
- API release notes: https://sondehealth.atlassian.net/wiki/spaces/SA/pages/2706866198/API+Release+Notes+and+Best+Practices
- API upgrade / compatibility policy: https://sondehealth.atlassian.net/wiki/spaces/SA/pages/2688450588/API+upgrades
- Audio format specifications: https://sondehealth.atlassian.net/wiki/spaces/SA/pages/2688122937/Audio+Format+Specifications
- Support: https://www.sondehealth.com/support — support@sondehealth.com

## Published contract

- Sonde Screening API (OpenAPI 3.0.0, 2 operations), embedded in the open-api macro at
  https://sondehealth.atlassian.net/wiki/spaces/SPPA/pages/1614250108/REST+API+Reference
- The Sonde Platform Service API's own OpenAPI is referenced by a macro pointing at
  https://sonde-partner-api.s3.ap-south-1.amazonaws.com/stage/api-platform-doc.yaml,
  which returns HTTP 404 NoSuchBucket as of 2026-08-28. That surface is documented in
  prose and curl examples only.

## Endpoint surface (from Sonde's published curl examples and release notes)

- POST /platform/v1/oauth2/token
- POST /platform/v2/users
- GET  /platform/v1/measures/name/{measureName}?variant={variant}
- POST /platform/v1/storage/files
- POST /platform/v1/inference/scores
- POST /platform/v2/inference/inference-parameters
- PUT  /platform/v2/inference/inference-parameters/{inferenceParameterId}
- POST /platform/v2/inference/scores
- GET  /platform/v2/inference/scores/{scoreId}
- POST /platform/async/v1/inference/voice-feature-scores
- GET  /platform/async/v1/inference/voice-feature-scores/{asyncJobId}
- GET  /platform/v1/inference/voice-feature-scores
- GET  /platform/v1/inference/voice-feature-scores/{voiceFeatureScoreId}
- POST /platform/async/v1/transcriptions
- GET  /platform/async/v1/transcriptions/{asyncJobId}
- GET  /platform/v1/storage/files/{filePath}/transcriptions
- POST /platform/v1/questionnaires
- GET  /platform/v1/questionnaires/{questionnaireId}?language={language}
- POST /platform/v1/questionnaire-responses
- GET  /platform/api/v1/screening-results

## What an agent should know before calling

- There is no self-service onboarding. Credentials and scopes come from Sonde under
  contract; unauthenticated calls return 403 {"message":"Missing Authentication Token"}.
- The input is human speech. An agent cannot synthesise a valid sample: Respiratory
  Symptoms Risk requires a single continuous held "ahh" for 6 seconds, and the
  Elicitation Check (ELCK) rejects samples that fail energy, voice-presence or
  correct-utterance validation with HTTP 422 ELICITATION_CHECK_FAILED.
- Audio is PHI under Sonde's HIPAA framing and must not leave the end user's country. A
  countryCode is required when requesting the signed upload URL.
- Errors are a vendor JSON envelope { code, message, requestId }, not RFC 9457.
- No rate limits, no idempotency keys and no webhooks are published.
- Deletion of stored voice samples and journals is available by emailing
  support@sondehealth.com; there is no delete operation and no stated retention window.

## Deprecations

- POST /platform/v1/users → POST /platform/v2/users
- Respiratory Symptoms Risk v1 → Respiratory Symptoms Risk variant V2
- Depressive Symptoms Risk API → disabled; use Mental Fitness Voice Features
- Java Server SDK (com.sondehealth:sondehealth-java 1.0.0, published 2020-08-03) — Sonde
  says "SDK is not updated frequently. Please use direct REST API for your integration."

## Repository artifacts

- openapi/sonde-health-screening-api-openapi.yaml
- authentication/sonde-health-authentication.yml
- scopes/sonde-health-scopes.yml
- errors/sonde-health-problem-types.yml
- conventions/sonde-health-conventions.yml
- lifecycle/sonde-health-lifecycle.yml
- changelog/sonde-health-changelog.yml
- data-model/sonde-health-data-model.yml
- packages/sonde-health-packages.yml
- sandbox/sonde-health-sandbox.yml
- conformance/sonde-health-conformance.yml
- plans/sonde-health-plans-pricing.yml
- rate-limits/sonde-health-rate-limits.yml
- skills/_index.yml