Sonde Health API Platform Documentation
Sonde Health Developer Documentation
Integrate the Sonde Health Platform to power your apps with Health Check scores.
The following documents are for Sonde Health’s Vocal Biomarker API (Application Programming Interface).
Getting Started : Sonde recommends for developers to go through this document
Sonde Health Platform Introduction : API Platform introduction
Guidelines to Integrate Sonde API in Mobile Application : Guidelines for developers
Account : Quick tutorial to open an account with Sonde
Use Cases : Quick start with examples
Functionality code snippets : Sonde API integration sequence diagram and reference code snippets to help you accelerate integration
Sonde's Mental Fitness Mobile App Implementation : This App uses the APIs described in this documentation
Sonde Server SDK : Java SDK
Mental Fitness Voice Features : Mental Fitness acoustic voice-feature score
REST API Reference : API documentation
API Release Notes and Best Practices : API release notes and best practices
Glossary : Understand the API platform concepts
Post Integration/Pre-Live Validation: Detail about contacting Sonde success team to help you in the integration of Sonde Vocal Biomarkers in your products
Introduction
The Sonde Platform Service API allows our Partners to access Sonde Vocal Biomarkers based Health Check with their own mobile and embedded applications. The Sonde Health Check is designed to measure the presence and/ or severity of various health or wellness conditions. The API is simple to use; Partners can integrate Health Check functionality into their apps in a few hours of development.
Sonde’s platform is HIPAA compliant and has banked over 1,000,000 voice samples from over 80,000 subjects to develop our voice-based Health Check models.
Getting started
With our API documentation and a "trial" key, you are ready to access our API in the staging environment. Once you have the “trial” key, you can develop and test your apps (note that test applications call our API staging environment. All voice test samples are banked in this location).
When you are ready to go live, contact our business development (partnerships@sondehealth.com) team. You will receive a "live" production key and updated terms and conditions.
The following is a summary of Health Check measures:
Respiratory Symptoms Risk
Users provide two 6-second voice samples (“Ahhh”) and receive a score that is designed to reflect the presence and/ or severity of respiratory symptoms. Scores can be used as objective measures of the potential presence or potential changes in respiratory symptoms.
Mental Fitness Feature Scores
Users provide a 30-second free speech recording, triggered by a randomized set of prompts and receive scores for Smoothness, Control, Liveliness, Energy range, Clarity, Crispness, Speech Rate, and Pause Duration biomarkers. All of the vocal biomarkers measured here have been shown to trend lower for individuals with reduced mental fitness and trend to higher values for individuals with higher mental fitness: therefore, increasing/ decreasing scores can be interpreted as increasing/ decreasing mental fitness, although other factors may also contribute (e.g. airway conditions, speech disorders, intoxication). These six scores are also used to calculate and provide the user with one unified Mental Fitness score.
Scores can be used to help promote, track and encourage choices, which, as part of a healthy lifestyle, may help to reduce their risk of or burden of decreased mental fitness symptoms.
Ask additional questions
As part of the app workflow, users (through API) may be asked demographic or health-based questions. Based on the subject scores, additional questions may also be asked, and a score provided to the users.
Thank you.
Sonde Health
support@sondehealth.com
Sonde Health