Use Circadify with AI Coding Agents

Install the Circadify SDK skill so AI coding agents (Claude Code, Cursor, etc.) integrate the Circadify SDKs correctly — one router skill covering Web, React, embed, iOS, Android, and REST.

If your team uses an AI coding agent to integrate Circadify, install the Circadify SDK skill. It's a single, router-style skill that gives the agent the right package names, types, method signatures, and idioms for every Circadify integration surface — the Web SDK, React bindings, the embed widget, native iOS and Android, and the REST API — so it gets the integration right from the first try.

The skill works with Claude Code, Cursor, and any agent that reads SKILL.md / AGENTS.md-style instructions.

Install

Also works in WSL and Git Bash on Windows. Add --global to install for every project.

curl -fsSL https://docs.circadify.com/install-skill.sh | sh

bash

Tip

Restart your agent after installing so it picks up the new skill. The agent activates it automatically when you ask it to integrate Circadify.

What you get

A self-contained skill folder. The agent reads SKILL.md first, then opens the reference file for your stack on demand:

circadify-sdk/
├── SKILL.md                 # router + happy-path quickstart + guardrails
├── reference/
│   ├── web.md               # @circadify/web-sdk (headless, vanilla JS/TS)
│   ├── react.md             # @circadify/react (provider, hooks, components)
│   ├── embed.md             # drop-in <script> widget
│   ├── ios.md               # CircadifySDK (Swift)
│   ├── android.md           # com.circadify:circadify-android-sdk (Kotlin)
│   ├── rest-api.md          # approved direct REST integration
│   ├── auth-and-keys.md     # ck_live_ vs ck_test_, session lifecycle
│   ├── errors.md            # error codes + troubleshooting
│   └── types.md             # result shapes, demographics, callbacks
└── examples/
    ├── react-minimal/       # runnable Vite + React integration
    ├── web-vanilla.html     # headless Web SDK, single file
    └── embed.html           # zero-build embed widget, single file

text

How it works

The skill is a router. SKILL.md carries the cross-cutting rules every integration needs — API keys, the result shape, error handling, and intended-use guardrails — plus a routing table that points the agent to the right reference/<platform>.md for the target stack. The agent loads only what it needs, so context stays small and accurate.

Other agents (Cursor, etc.)

The skill is plain Markdown. Point your agent at circadify-sdk/SKILL.md, drop the folder into your repo, or paste SKILL.md into your project's AGENTS.md or rules file.

Claude Code

Installed to .claude/skills/ — Claude Code discovers it automatically and activates it when relevant.

Cursor and other agents

Reference circadify-sdk/SKILL.md from your AGENTS.md or rules. The agent reads the routing table and follows the reference files.

Verify the integration

Before treating an integration as done, have the agent run a real scan — a successful measureVitals (or embed onComplete, or REST result) that returns a non-zero confidence and a UUID sessionId. That proves the full round-trip worked, not just that the code compiled.

Tip

Use a ck_test_ sandbox key for this. Sandbox scans return simulated vitals with the same result shape, never count against your quota, and are never billed. Get one at developer.circadify.com.