Circadify

Introduction

Circadify rPPG API and SDK for contactless vital signs from a device camera.

Circadify is a platform for camera-based vital signs from a standard device camera. The SDK guides the scan, prepares a secure measurement payload, and returns configured outputs through the Circadify API.

Supported Outputs

A single 30-second scan from a smartphone or laptop camera can return:

OutputUnitAvailability
Heart RateBPMStandard
Heart Rate VariabilitymsStandard
Respiratory Ratebreaths/minStandard
Blood Oxygen (SpO2)%Configuration-dependent
Systolic Blood PressuremmHgConfiguration-dependent
Diastolic Blood PressuremmHgConfiguration-dependent

Each result includes a confidence score (0-1) indicating measurement reliability. Metric availability depends on account configuration, SDK version, device quality, and intended use.

How It Works

  1. Local capture — The SDK opens the camera with permission, guides scan quality, and prepares the measurement payload locally. Raw camera frames never leave the device.

  2. Secure upload — The SDK uploads a measurement payload for processing. No photos, video, or raw frames are transmitted.

  3. Secure processing — Circadify processes the SDK-prepared payload and returns configured vital sign outputs.

  4. Results returned — Vital signs with confidence scores are returned to your application. No health data is stored by Circadify by default.

Tip

The SDK does not upload photos, raw video frames, or identifiable images.

Integration Options

  • Web SDK (@circadify/web-sdk) — Headless JavaScript/TypeScript library for browser-based measurement flows. Works in Chrome 80+, Firefox 75+, Safari 14+, and Edge 80+. Includes built-in React bindings — pre-built CircadifyProvider and CircadifyScan components with hooks.
  • iOS SDK (CircadifySDK) — Native Swift package for iOS 17.0+ apps (Swift 5.10+). Distributed via Swift Package Manager.
  • Android SDK (com.circadify:circadify-android-sdk) — Native Kotlin SDK for Android apps.
  • Python SDK (circadify) — Capture from a webcam, a video file, or your own frames; on-device face/ROI processing, server inference. Includes a drop-in thermal face-glow overlay and a headless REST/tensor path for servers and batch jobs.
  • REST API — Server-side endpoints for session management, result retrieval, and account operations. Authenticate with API keys.
  • Headless mode — Full SDK capabilities without any UI, for custom implementations.

Developer Portal

Create your account and manage everything at developer.circadify.com:

  • Create and revoke API keys
  • Test a scan locally with the SDK
  • Manage billing and upgrade plans

Next Steps