Introduction

Important: Server Migration

Migrating to V2 is simple - just add ONE LINE OF CODE!

We recommend using the V2 server (CrimsonLion backend) for all new projects. The V1 server (NyanCat) will be deprecated on June 30, 2026.

To migrate to V2, simply add:

precisionMode: PrecisionMode.relaxed

See our V1 to V2 Migration Guide for detailed instructions.

This documentation describe how to use the Vitals™ SDK to develop software that integrates the Vitals™ Health Assessment (VHA) process with the Vitals™ Cloud Service provided by PanopticAI.

Features

• Vital Sign Measurements - Obtain a personalized health report in just 30 seconds.
• Scan Quality Assurance - Provide scan conditions and signal quality metrics.
• Camera Flexibility - Easily switch between different cameras.
• Easy-to-Use API - Enable quick integration and prototyping with user-friendly APIs.
• Flexible UI - Fully-customizable user interface design and styling.
• Cross-Platform Compatibility - Support both desktop and mobile devices.
• Sample Code - Provide full-featured sample code for various frameworks.

Minimum System Requirements

AndroidAndroid	iOSiOS	Desktop PCDesktop PC
Android 7.0 (API Level 24) or above Camera with frame rate of 30 fps 3GB RAM	iOS 11 or above iPhone 8 or above iPad 6th generation or above	Windows 10 64bit, i3 processor or above macOS 11.0 or above Camera with resolution 640x480 and 30fps

Minimum Development Environment

• Node 16.13
• Xcode 14 (for iOS development only, macOS required)
• Android Studio Electric Eel | 2022.1.1 (for Android development only)

Supported Frameworks or Languages

Frameworks / LanguagesFrameworks / Languages	PlatformsPlatforms	Operating SystemsOperating Systems
JavaScript or TypeScript	Web	Windows macOS iOS Android
React	Web	Windows macOS iOS Android
Vue	Web	Windows macOS iOS Android
Flutter	iOS Android	iOS Android
ReactNative	iOS Android	iOS Android
Kotlin or Java	Android	Android
Swift	iOS	iOS