Installation

The Circadify Web SDK is available as an npm package and via CDN.

Package Manager

Install @circadify/sdk with your preferred package manager. The SDK ships as ESM with a CommonJS fallback.

npm

npm install @circadify/sdk

yarn

yarn add @circadify/sdk

pnpm

pnpm add @circadify/sdk

CDN

For projects that don’t use a bundler, load the SDK directly from the Circadify CDN. The script exposes a global CircadifySDK constructor.

<script src="https://cdn.circadify.com/sdk/v1/circadify.min.js"></script>
<script>
  const sdk = new CircadifySDK({
    apiKey: 'ck_test_your_key_here',
  });
</script>

Caution

Pin the version in the URL for production deployments (e.g., /sdk/v1.2.0/circadify.min.js) to avoid unexpected breaking changes.

Requirements

• Bundle size: ~38 KB (ESM core). WebAssembly modules (~6 MB) are lazy-loaded from CDN on first use and cached by the browser.
• HTTPS: Required for camera access. localhost works during development.
• Browser support:

Browser	Minimum Version
Chrome	80+
Firefox	75+
Safari	14+
Edge	80+

• Required browser APIs:

API	Purpose
WebAssembly	Vision Engine execution (face detection, skin region extraction)
Web Workers	Background frame processing
MediaDevices (navigator.mediaDevices)	Camera stream access
WebGL (optional)	Hardware-accelerated frame processing; falls back to Canvas 2D

TypeScript Support

The SDK ships with full TypeScript definitions included. No additional @types package is needed.

import {
  CircadifySDK,
  CircadifyError,
  CircadifyErrorCode,
  type CircadifyConfig,
  type VitalSignsResult,
  type ProgressEvent,
  type QualityWarning,
} from '@circadify/sdk';

All public interfaces, callback signatures, and error types are exported. TypeScript 4.7 or later is recommended for full ESM support.

Next Steps

• Configuration — Configure the SDK for your use case
• Quick Start — End-to-end getting started guide