Sonde Health API Platform Documentation
Sonde's Mental Fitness Mobile App Implementation
The following describes Sonde’s Mental Fitness mobile app which uses the APIs described in this documentation. This App can be downloaded from Apple’s App Store. Android version on the Play Store will be available in Sept. 2021. Developers can gain insight into Sonde’s app flow, which is one of many possible user cases, for guidance prompts, messaging, score display, and resources link.
High-Level Interaction Diagram
Shown in green and yellow images below are components of Sonde’s Mental Fitness app. Both these components interface via an API to the Sonde API Platform. The MF App Backend registers the user with the end user’s ID. Sonde API platform also generates a unique ID for the user and all interactions with the Sonde API Platform for that user are linked to the specific unique ID.
App Workflow
The following is the App flow.
SignUp
In sign-up flow, MentalFitness server calls the following API
POST /platform/v2/users
Personally identifiable information (PII) is stored in the MentalFitness server (MF App Backend) associate with a unique users ID which includes email, cell, gender, YOB, time zone, and device model. Linked to the user ID is Sonde given ID. This Sonde given ID (which is not PII) is passed to Sonde Platform along with audio, App info, gender, YOB, language, and score which are also not PII given that Sonde given ID cannot be linked to the end-user.
More API details can be found at REST API Reference.
CheckIn Prompts, Voice Sample, Scores, Transcribed Journal, and History
Prompts - After user check-in, users are prompted to give a 30-second voice sample. The prompts for the voice sample are selected sequentially from 50 or so prompts. Partners can implement a fixed prompt such as “what’s on your mind” or give users an option to respond to the fixed prompt or different prompts. Sample prompts are listed below. The APIs do not support prompt function.
Tips - The App includes the display of tips selected randomly for a sample list provided below. The APIs do not support tip function.
Emoji Selection - Users are asked to select the “I am feeling…” emoji and the reason for their feeling emojis.
Voice Sample - A countdown timer is displayed for a few seconds and then the recording starts. Users voice response is recorded and sent to the backend
Scoring - After receiving user scores, the Aggregate score is displayed, and below are the six Acoustic scores. Additional score panels are visible by clicking on any of the six Acoustic scores.
Transcribe - Another parallel job that runs after the collection of the voice sample is transcribing. The App currently supports only English language transcribing. The same voice sample that is scored is also transcribed. Sonde APIs support transcribe function.
History - The App shows score history as well as transcribed journal history. Sonde APIs support access to users' scores and Journal history.
The MentalFitness app initiates two jobs with the API Platform during the user’s check-in.
The first job is for voice feature scores:
POST /platform/async/v1/inference/voice-feature-scores
GET /platform/async/v1/inference/voice-feature-scores/{asyncJobId}
Refer use-case document Mental Fitness Voice Features API for more detail
The second job is for transcribe:
POST /platform/async/v1/transcriptions
GET /platform/async/v1/transcriptions/{asyncJobId}
Refer use-case document Journaling for more detail
Prompts
The following are sample prompts that are sequentially presented to the users each time they initiate a health check.
Be prepared to talk about…
How are you feeling today?
Describe your perfect day.
What inspires you?
Describe things that make you happy.
What advice would you give to someone going through a hard time?
What makes you feel fulfilled?
What things are you avoiding dealing with?
Your favorite way to spend the day
Describe the things that make you smile.
What couldn’t you imagine living without?
What do you love about life?
What can you learn from your biggest mistakes?
When do you feel most energized?
How has your week been so far?
How is your work or school going - and how do you think it will go in the future?
What would you say are some of your best qualities?
What are some things that usually put you in a good mood?
Describe how you’ve been feeling during the past week.
What are you looking forward to this week?
Tips:
Practice meditation
Get regular exercise
Read a book
Take a break
Explore the outdoors
Eat well
Connect with friends
Play brain games
Take up a hobby
Develop a sleep routine
Stay hydrated
Go for a walk
Express gratitude
Ask for help
Reduce screen time
Embrace boredom
Declutter your space
Try breathing exercises
Control worried thoughts
Understand exhaustion
New tips:
Listen to music
Write a poem or short story
Browse virtual exhibitions
Volunteer to help others
Make some arts and crafts
Make a memory box
Light some candles
Cuddle with a pet (or: get a pet?)
Check in with your healthcare team
Watch your favorite TV show
Make music with others
Practice yoga
Take time off
Start gardening
Help out a neighbor
Stretch
Do a body-scan meditation
Tell loved ones you care about them
Plant a tree or flowers
Take a hot bath or shower
Sonde Health