Skip to main content

API

Developer Platform

Contactless Vital Signs in Your App

The Circadify API brings rPPG-powered vital sign estimation to any application. Extract heart rate, respiratory rate, HRV, blood pressure, and SpO2 from standard camera video — no wearables, no hardware, no contact.

Our SDKs

Two Platforms, One API

Integrate contactless vital signs into web or native iOS apps. Same 6 vital signs, same clinical-grade accuracy, same simple API.

Web SDK

@circadify/sdk

Browser-based vital sign measurement. Works in Chrome, Firefox, Safari, and Edge. On-device face detection via WebAssembly — raw video never leaves the browser.

app.ts
import { CircadifySDK } from '@circadify/sdk';

const circadify = new CircadifySDK({
  apiKey: 'YOUR_API_KEY',
});

const result = await circadify.measureVitals({
  container: document.getElementById('scan'),
});
Installnpm install @circadify/sdk
Chrome 80+Firefox 75+Safari 14+Edge 80+
Apple

iOS SDK

CircadifySDK

Native iOS vital sign measurement. Uses AVFoundation for camera capture and Apple Vision for real-time face detection. Captures video, uploads securely, and returns clinical-grade results from the Circadify cloud.

ContentView.swift
import CircadifySDK

let circadify = try CircadifySDK(
    config: CircadifyConfig(apiKey: "YOUR_API_KEY")
)

let vitals = try await circadify.measureVitals()
print(vitals.heartRate) // 72 BPM
InstallSwift Package Manager
iOS 15+Swift 5.7+Xcode 14+Physical Device

Both SDKs measure

6 Vital Signs

Heart RateHeart Rate VariabilityRespiratory RateBlood Oxygen (SpO2)Blood PressureStress Level
30sScan Duration
HIPAACompliant
MITLicensed
Open SourceBoth SDKs
Capabilities

Built for Developers

Real-Time Processing

Stream video frames via WebSocket and receive vital signs in under 30 seconds. No batch processing delays.

Simple Integration

Drop-in JavaScript SDK or RESTful API. Get vitals flowing in your app with fewer than 10 lines of code.

HIPAA Compliant

End-to-end encryption, zero video storage, BAA-ready. Built for healthcare from day one.

Edge Processing

On-device inference available. Video never leaves the user's device for maximum privacy.

Cross-Platform

Works in browsers, iOS, Android, and embedded devices. One API, every platform.

Rich Analytics

Heart rate, respiratory rate, HRV, blood pressure, SpO2, and stress — all from a single scan.

Quick Start

Get Started in Minutes

app.ts
import { CircadifySDK } from '@circadify/sdk';

const circadify = new CircadifySDK({
  apiKey: 'YOUR_API_KEY',
});

// SDK mounts video + face guide + progress bar in your container
const result = await circadify.measureVitals({
  container: document.getElementById('scan-container'),
});

console.log(result);
// {
//   heartRate: 72,
//   hrv: 45.2,
//   respiratoryRate: 16,
//   spo2: 98,
//   systolicBp: 120,
//   diastolicBp: 80,
//   confidence: 0.95,
//   sessionId: 'abc-123'
// }

SDK Methods

ASYNC
measureVitals(options?)Start a measurement — pass container for built-in UI, omit for headless mode
ASYNC
checkCameraAccess()Check if a camera is available and permissions are granted
SYNC
getDeviceCapabilities()Returns device camera info including resolution and FPS
SYNC
destroy()Clean up all resources — WASM, camera stream, and UI
EVENT
onProgress(event)Real-time progress updates with phase and percentage
EVENT
onQualityWarning(warning)Alerts when lighting, motion, or pose affect accuracy
What Users Say

Real Feedback From Real Users

Would Recommend to a Friend or Family Member

I told my family about the app, and they were amazed at how the technology works and how quick the scan was.

— Winnie, 24, Mother

Found the Scan Easy to Complete

I just looked at my phone for a few seconds and it gave me my vitals. The people around me wanted to try it as well.

— George, 28, Businessman

Believe It Could Improve Community Health Access

Where I'm from, getting to a medical center for basic stuff requires a long wait. Something like this could change that.

— Akunda, Accountant, 26

Support

API Frequently Asked Questions

The Circadify rPPG API is a RESTful interface that allows developers to integrate contactless vital sign estimation into their applications. Using video input from any standard camera, the API returns heart rate, respiratory rate, HRV, blood pressure, and SpO2 readings in real time.

Our rPPG-Web SDK is built with JavaScript/TypeScript and runs natively in modern browsers. We also provide REST API endpoints that can be consumed from any language — Python, Java, Go, Swift, Kotlin, and more. Check our GitHub repo for code examples.

Authentication is handled via API keys provided when you create a Circadify developer account. Each request must include your API key in the Authorization header. We support both test and production keys with separate rate limits.

Free tier accounts receive 100 API calls per day. Growth plans include 10,000 calls per day, and Enterprise plans offer unlimited calls with dedicated infrastructure. All plans include real-time WebSocket streaming support.

Yes. All API communication is encrypted via TLS 1.3. Video data is processed in-memory and never stored on our servers. We offer Business Associate Agreements (BAA) for healthcare organizations. On-premise deployment is also available for Enterprise customers.

Absolutely. The rPPG-Web library runs in mobile browsers, and our native SDKs for iOS and Android wrap the API for seamless mobile integration. The SDK handles camera access, face detection, and vital sign extraction with a few lines of code.

The API works with standard webcam and smartphone cameras. We recommend at least 640x480 resolution at 30fps for optimal accuracy. The SDK includes built-in quality checks that notify users when lighting or camera conditions may affect results.

Our rPPG models achieve clinical-grade accuracy validated against FDA-cleared devices. Heart rate measurements correlate within +/-3 BPM, and respiratory rate within +/-2 breaths per minute under controlled conditions. See our published research for detailed validation studies.

Get Started

Get API Access

Request your API key and start building with contactless vital signs today.

Request A Demo

See how contactless vitals can transform your healthcare delivery.

Learn More

From the Blog