Circadify

Quick Start

Sign up, create an API key, and pick your SDK to start measuring contactless vital signs with Circadify.

This guide walks you through signing up, creating an API key, and choosing the SDK that fits your stack.

Prerequisites

  • A Circadify developer account (free, approved within 24 hours)
  • HTTPS for any page that opens the camera (localhost works for development)

Create Your Account

  1. Sign up at developer.circadify.com

    Fill in your name, work email, company, and category. Your account will be submitted for review.

  2. Wait for approval

    Our team reviews new accounts and you'll receive an email when approved. This typically takes less than 24 hours.

  3. Log in at developer.circadify.com/login

    Once approved, log in with your email and password to access the developer dashboard.

Create an API Key

  1. Navigate to the Keys page in the dashboard sidebar.

  2. Click Create Key.

  3. Enter a name (e.g., "Development" or "Production").

  4. Copy your key immediately. It's only shown once. You'll see the key in this format (ck_live_ or ck_test_ followed by 40 lowercase hex characters):

    ck_live_4f9d2c8b1a6e3f7d0c5b9a8e2f4d6c1b3a7e5f90
    text
Caution

Your full API key is displayed only once at creation time. After that, only the prefix is visible in the dashboard. Store it securely — if you lose it, you'll need to create a new one.

Pick an SDK

Each SDK's install guide lives under the Integrate section of the developer portal (Web, iOS, Android, Python); your SDK access token — the credential that downloads the private packages — is under Settings → SDK Access. Choose the SDK that matches your stack — the linked guide takes you through installation and your first scan.

Web SDK

@circadify/web-sdk — headless TypeScript SDK for vanilla JS, Vue, Svelte, or any framework with a build step, plus built-in React bindings (provider, hooks, and a styled <CircadifyScan> component).

iOS SDK

Native Swift package for iOS apps — camera permissions, capture, callbacks, and result retrieval.

Android SDK

Native Kotlin SDK for Android apps — CameraX preview support, callbacks, cancellation, and result retrieval.

Python SDK

circadify — capture from a webcam, a video file, or your own frames, with a drop-in thermal face-glow overlay and a headless REST/tensor path for servers.