Get Started in 5 Minutes

Developer
Quickstart Guide

Install the SDK, initialize with your API key, start measuring heart rate, HRV, and stress. Four steps, five minutes.

🎮
Try it live before integrating
No signup required. Test the full API response in your browser.
Test the API →
Integration guide

Four steps to vital signs

From npm install to real-time heart rate data. Copy, paste, ship.
1

Install the SDK

Add the Beam AI SDK to your project with npm or yarn.

Terminal
npm install @beam-ai/sdk
2

Initialize with your API key

Import the SDK and create a client instance. Get your API key from the dashboard.

app.js
import { BeamAI } from '@beam-ai/sdk';

const beam = new BeamAI({
  apiKey: 'beam_your_key'
});
3

Start a measurement

Request camera access and begin extracting vital signs. The SDK handles face detection, ROI tracking, and rPPG signal processing automatically.

app.js
// Get the video element from your page
const video = document.getElementById('camera-feed');

// Start the camera and begin measurement
const session = await beam.createSession({
  videoElement: video,
  duration: 30, // seconds (minimum recommended)
});

// Listen for real-time vitals
session.on('vitals', (data) => {
  console.log('Heart Rate:', data.heart_rate);
  console.log('HRV:', data.hrv);
  console.log('Stress:', data.stress_index);
});

session.start();
4

Read the results

When the session completes, you get a full vitals snapshot. All processing happens on-device -- no video data leaves the user's phone.

Output
{
  "heart_rate":       72,        // BPM (±2 accuracy)
  "hrv":             48.3,      // RMSSD in milliseconds
  "stress_index":    127.5,     // Baevsky Stress Index
  "spo2":            98,        // Blood oxygen %
  "respiration_rate": 16,        // Breaths per minute
  "confidence":      0.94,      // Signal quality score
  "duration_ms":     30120      // Measurement duration
}
Technical specifications

Under the hood

Everything you need for your architecture review.
Platform Support
iOS SDK (Android + Web coming soon)
Heart Rate Accuracy
±2 BPM
Metrics
HR · HRV · Stress · SpO2 · Respiration
HRV Method
RMSSD
Stress Algorithm
Baevsky Stress Index
Min. Measurement
30 seconds
Camera Requirement
30fps front-facing
Processing
100% On-Device
Compliance
HIPAA · GDPR
Data Storage
Zero biometric data stored

Ready to build?
Get your API key.

Free tier available. No credit card. Start shipping vital sign monitoring in your app today.

Get API Key

$99/mo starter · Free sandbox · Cancel anytime