API Reference
The Virtuosis REST API v1.2 lets third-party applications create user accounts, upload Base64-encoded audio recordings, poll health analysis results, and inspect recording usage.
Environments
Authentication
All requests require a bearer token:
Requests with JSON bodies must also include:
Processing guidance
- Create one account per user.
- Upload audio as a Base64-encoded string in the JSON
audiofield. - Specify which analysis types to run (
wellbeing,parkinsons,alzheimers). Theanalysisarray is required and must contain at least one type. - Do not send multipart file uploads to the recording endpoint.
- Use at least 30 seconds of free speech. If needed, prompt the speaker with an open-ended question such as “How’s your day going?” or “Can you introduce yourself?”
- Poll analysis results every 15 to 30 seconds.
- Do not poll more frequently than every 5 seconds.
- Use a five-minute timeout for analysis processing.
Error guidance
All endpoints use the same error response shape. Error type values are documented in the OpenAPI schema and may expand over time. Internal server errors may not include a detailed message, but are recorded by Virtuosis error tracking for debugging.
