Skip to main content

Developer SDK & API

Developer Tools

Build Contactless Vitals Into Your App

Circadify provides a powerful JavaScript SDK and REST API that lets you integrate contactless vital sign detection directly into your web or mobile application.

Full TypeScript support, WebSocket streaming for real-time results, and comprehensive documentation to get you up and running in minutes.

Real-time Processing

Get vital signs in under 30 seconds with streaming results

WebSocket Support

Live data streaming for continuous monitoring

Cross-Platform

Works on web, iOS, Android, and desktop

Full Documentation

Comprehensive guides, examples, and API reference

Developer Tools & Features

Everything you need to build health-enabled applications

npm install

JavaScript SDK

Lightweight SDK with simple initialization. Import, configure, and start capturing vitals in minutes.

JSON responses

REST API

Full-featured REST API for server-side integration. Upload video frames and receive structured vital sign data.

Real-time

WebSocket Streaming

Real-time bidirectional communication for live vital sign updates during capture sessions.

Type-safe

TypeScript Support

Full TypeScript definitions included. Enjoy type safety and intelligent autocomplete in your IDE.

React / Vue

Framework SDKs

Pre-built components for React, Vue, and Angular. Drop-in UI components for faster development.

Event-driven

Webhook Events

Configure webhooks to receive notifications when measurements complete or thresholds are crossed.

Quick Start Guide

Get from zero to capturing vitals in 6 simple steps

1

Get API Credentials

Sign up for a developer account and generate your API keys from the dashboard.

2

Install SDK

Install the Circadify SDK via npm, yarn, or include directly from our CDN.

3

Initialize Client

Configure the SDK with your API key and optional settings for your use case.

4

Capture Vitals

Access the camera, start a capture session, and let our AI analyze the video stream.

5

Handle Results

Receive structured vital sign data including heart rate, BP, SpO2, and confidence scores.

6

Go to Production

Swap sandbox keys for production credentials and deploy your health-enabled app.

Simple, Clean API

Our SDK is designed for developer experience. Initialize with your API key, start a session, and receive vital signs through clean callbacks or async/await patterns.

30s
Time to First Vital
5+
Vital Signs
<5
Lines to Integrate
24/7
Developer Support

// Initialize Circadify SDK

import { Circadify } from '@circadify/sdk';


const client = new Circadify({

apiKey: 'your_api_key'

});


// Start vital sign capture

const vitals = await client.captureVitals({

videoElement: '#camera',

duration: 30

});


// Access results

console.log(vitals.heartRate); // 72

console.log(vitals.bloodPressure); // {sys: 120, dia: 80}

console.log(vitals.spO2); // 98

Developer Use Cases

1

Wellness & Fitness Apps

Add vital sign tracking to fitness, meditation, and wellness applications. Give users insights into their cardiovascular health without wearables.

2

Telehealth Platforms

Embed vital sign capture directly into your telehealth video calls. Providers see real-time patient vitals during consultations.

3

Clinical Research

Collect vital sign data from study participants remotely. Reduce site visits while maintaining data quality and compliance.

4

Insurance & Underwriting

Streamline health assessments for insurance applications. Capture vitals remotely to speed up underwriting processes.

Start Building with Circadify

Get your API keys and start integrating contactless vitals today.

Explore More Integrations

Request A Demo

See how contactless vitals can transform your healthcare delivery.