Skip to content

VitalLens API Documentation

Welcome to the VitalLens API developer documentation. VitalLens allows you to estimate physiological vital signs like heart rate, heart rate variability (HRV), respiratory rate, and more from any face video using remote photoplethysmography (rPPG).

It powers our VitalLens iOS App, and now it can power your application too.

➡ Get your API Key

Client Libraries

Select your platform to get started.

  • Python Client

    Full support for video files and raw numpy arrays. Best for research and backend integration.

    ➡ Python Docs

  • JavaScript Client

    Run VitalLens in the browser or Node.js. Includes pre-built Web Components (widgets) for instant UI integration.

    ➡ JavaScript Docs

  • Direct API

    Language-agnostic HTTP endpoints. Use this for cURL, Go, Ruby, or any workflow not covered by our SDKs.

    ➡ API Reference

Core Concepts

Understand the technology and constraints behind the API.

  • ⚙ How it Works
    • Learn about the stateless pipeline and preprocessing steps.
  • 🎯 Accuracy & Guidelines
    • Review benchmarks and best practices for lighting, framing, and compression.
  • 🔒 Privacy & Legal
    • Understand our "Process and Delete" policy, medical disclaimers, and prohibited uses.