Skip to main content

Nervoscan-js SDK

npm version TypeScript

Welcome to the Nervoscan-js SDK — your gateway to integrating contactless health monitoring technology into your web or mobile apps using JavaScript or TypeScript.

🧠 What is Nervoscan-js SDK?​

The Nervoscan-js SDK allows developers to embed real-time vital sign measurement features into their platforms using just a standard camera and a few lines of code.

By leveraging advanced computer vision, signal processing, and cloud-based AI models, Nervoscan turns a simple video stream into actionable health insights like:

  • 💓 Heart Rate (HR)
  • 🌬️ Respiratory Rate (RR)
  • 😰 Stress Index
  • 🩸 Oxygen Saturation (SpO₂)
  • 🔬 Additional Metrics (Blood Pressure, HbA1c, etc., based on configuration)

🚀 Why Use the Nervoscan-js SDK?​

  • Seamless Integration: Add contactless health measurements to your app without the need for wearables or external hardware.
  • Real-time Streaming Support: Stream video data in real-time using WebSocket-powered infrastructure.
  • Video Upload Workflow: Analyze pre-recorded videos asynchronously via API.
  • Developer-Friendly: Clean TypeScript typings, clear error handling, and modular design patterns.
  • Reliable Results: Backed by Nervotec’s proprietary algorithms and cloud infrastructure.

🛠️ What You Can Build With It​

  • Telemedicine apps with embedded vital signs monitoring
  • Wellness platforms offering stress and heart rate tracking
  • Employee health check kiosks
  • Research tools for non-contact physiological measurement
  • Any app that wants to offer contactless health insights

📌 Key Features​

  • ✅ API key and session-based authentication
  • ✅ Real-time video streaming from browser webcam
  • ✅ Pre-recorded video upload and analysis
  • ✅ Partial (window-based) and final result callbacks
  • ✅ Built-in error classes for robust error handling

📚 What’s in This Documentation?​

  • Client Class Overview – Learn core methods like initialization, streaming, video upload, and result handling
  • Integration Guide – Step-by-step examples for adding Nervoscan to your frontend or Node.js backend
  • Error Handling – Full list of custom error classes and how to manage them
  • Result Formats – Understand the data structures returned from scans

🚩 Get Started Quickly​

npm install nervoscan-js-sdk