# Synheart

> Developer documentation for Synheart SDKs, protocols, and tools.

## Docs

- [Introduction](/introduction.md): Privacy-preserving, human-state-aware AI from biosignals, behavior, and context
- [Quickstart](/quickstart.md): Build your first emotion-aware app in 5 minutes

- [Setup Overview](/setup/overview.md): The four steps to go from zero to a working Synheart integration
- [Install the CLI](/setup/install-cli.md): Install synheart-cli on macOS, Linux, or Windows
- [Create a Platform Account](/setup/create-account.md): Request invite access and create your Synheart platform account
- [Authenticate the CLI](/setup/authenticate.md): Sign the CLI in to your Synheart platform account
- [Install the Runtime](/setup/install-runtime.md): Install the on-device HSI runtime required by Synheart Core

- [Synheart CLI](/synheart-cli.md): Main CLI for local development - generates mock HSI data streams for SDK testing

- [Platform Overview](/platform/overview.md): Synheart developer platform — organizations, projects, apps, and access control
- [Developer Portal](/platform/developer-portal.md): Sign in, create an organization, register apps, and configure ingestion access on platform.synheart.ai
- [API Keys](/platform/api-keys.md): Generate per-app API keys and scope them for ingestion + dashboard access
- [App Attestation](/platform/app-attestation.md): Per-app device-integrity attestation with Play Integrity and App Attest
- [Projects & Wearables](/platform/projects.md): Organize apps, devices, and sessions inside tenants and projects
- [App Policy](/platform/app-policy.md): Configure what data your app may collect and where it may be processed — the per-app layer of the consent model
- [Consent Profiles](/platform/consent-profiles.md): Per-app consent blueprints the SDK uses at consent time to render what's offered to end users

- [Human State Interface (HSI)](/hsi/overview.md): A contract-only, language-agnostic JSON payload for exchanging human-state signals (HSI 1.0)

- [Synheart Wear Overview](/synheart-wear/overview.md): Unified wearable SDK for streaming biometric data across devices and platforms
- [Wearable Signals](/synheart-wear/signals.md): What data you actually get from each supported wearable — three access gates, raw signals, processed human-state output
- [Wear Adapters](/synheart-wear/adapters.md): PermissionType mapping and adapter-by-adapter behavior across iOS, Android, BLE, and vendors
- [Wear Data Schema](/synheart-wear/data-schema.md): WearMetrics — the unified output every adapter normalises to
- [Synheart Wear - Dart/Flutter SDK](/synheart-wear/flutter.md): Cross-platform wearable SDK for Flutter apps (iOS + Android)
- [Synheart Wear - Kotlin/Android SDK](/synheart-wear/kotlin.md): Native Android SDK with Health Connect integration
- [Synheart Wear - Swift/iOS SDK](/synheart-wear/swift.md): Native iOS SDK with HealthKit integration
- [BLE Heart Rate Monitor](/synheart-wear/ble-hrm.md): Direct Bluetooth LE heart rate monitor support for real-time HR streaming
- [Wear Errors](/synheart-wear/errors.md): SynheartWearError taxonomy, permission failures, and adapter-specific error modes

- [Synheart Auth Overview](/synheart-auth/overview.md): Hardware-backed device identity and request signing for Synheart mobile SDKs
- [Auth Registration Flow](/synheart-auth/registration.md): Challenge → keygen → attestation → register flow
- [Auth Request Signing](/synheart-auth/signing.md): Message construction, signed headers, and server-side verification
- [Auth State Machine](/synheart-auth/state-machine.md): Device authentication state machine
- [Auth Errors](/synheart-auth/errors.md): SynheartAuthError taxonomy, key invalidation detection, and clock skew correction

- [Synheart Core SDK Overview](/synheart-core/overview.md): Unified SDK for human-state intelligence — single integration point for all Synheart features
- [Synheart Core - Dart/Flutter SDK](/synheart-core/flutter.md): Unified SDK for human-state intelligence in Flutter applications
- [Synheart Core - Android/Kotlin SDK](/synheart-core/kotlin.md): Unified SDK for human-state intelligence in Android applications
- [Synheart Core - iOS/Swift SDK](/synheart-core/swift.md): Unified SDK for human-state intelligence in iOS applications
- [Synheart Core - Edge SDK](/synheart-core/edge.md): Slim watch-class SDK for streaming biosignals + running on-device HSI on Apple Watch and Wear OS
- [Synheart Core Architecture](/synheart-core/architecture.md): Deep dive into the Core SDK module system and HSI Runtime
- [Human State Vector (HSV)](/synheart-core/hsv-specification.md): Internal Human State Vector model — axes, indices, embeddings, windows
- [HSI (Synheart Core)](/synheart-core/hsi-specification.md): How Synheart Core exports HSV as HSI 1.0 payloads and consumes HSI for interoperability
- [Capability System](/synheart-core/capability-system.md): Access control enforcement based on app identity and authorization level
- [Consent System](/synheart-core/consent-system.md): User permission management and privacy boundary enforcement across all Synheart Core modules
- [Cloud Protocol](/synheart-core/cloud-protocol.md): Secure, consent-gated upload protocol for HSV snapshots (HSI 1.0 format) to the Synheart Platform
- [Scoring Models](/synheart-core/scoring.md): Typed input + result classes for the Sleep / Recovery / Readiness scorers — cross-language byte-equivalent JSON
- [Self-Reference Model (SRM)](/synheart-core/srm.md): Per-subject longitudinal baseline engine — dimensions, maturity states, reference view, snapshot lifecycle
- [Baselines Facade](/synheart-core/baselines.md): Typed observable snapshot of the user's wearable-baseline state — latest scores + reference view + recent-scores ring
- [Breathing Module](/synheart-core/breathing.md): 4-pillar breathing-compliance detector — configure target rate, evaluate over the current RR window, render coaching
- [Health Backfill](/synheart-core/health-backfill.md): Cold-start SRM seeding from Health Connect (Android) or HealthKit (iOS) historical sleep + overnight HR/HRV
- [Runtime FFI Surface](/synheart-core/runtime-ffi.md): The stable C ABI between the open-source Synheart SDKs and the runtime native binary

- [Synheart Behavior Overview](/synheart-behavior/overview.md): On-device behavioral signal inference from digital interactions with privacy-first design
- [Behavior Metric Definitions](/synheart-behavior/metric-definitions.md): Formal definitions of the BehavioralMetrics fields and the formulas used to compute them
- [Behavior Model Card](/synheart-behavior/model-card.md): The bundled Linear SVC motion-state classifier — inputs, classes, runtime, and known limits
- [Behavior Threat Model](/synheart-behavior/threat-model.md): What the SDK collects, what it deliberately does not, and the platform-permission surface
- [Synheart Behavior - Dart/Flutter SDK](/synheart-behavior/flutter.md): On-device behavioral signal inference for Flutter applications
- [Synheart Behavior - Kotlin/Android SDK](/synheart-behavior/kotlin.md): On-device behavioral signal inference for Android applications
- [Synheart Behavior - Swift/iOS SDK](/synheart-behavior/swift.md): On-device behavioral signal inference for iOS applications
- [Synheart Behavior - Chrome Extension](/synheart-behavior/chrome.md): Browser-side behavioral input — timing and patterns only, streamed to your local sensor agent
- [Behavior Errors](/synheart-behavior/errors.md): Permission failures, lifecycle errors, and the runtime-gate drop semantics

- [Syni Overview](/syni/overview.md): Adaptive on-device LLM inference for Synheart apps — what Syni is and how the pieces fit together
- [Syni - Flutter SDK](/syni/flutter.md): Adaptive on-device LLM inference with hybrid local/cloud chat, persona conditioning, and a streaming API designed for the UI thread
- [Syni - Kotlin SDK](/syni/kotlin.md): Android SDK for Syni's adaptive on-device LLM inference with hybrid local/cloud chat
- [Syni - Swift SDK](/syni/swift.md): iOS / macOS SDK for Syni's adaptive on-device LLM inference with hybrid local/cloud chat
- [Syni Runtime FFI](/syni/runtime-ffi.md): The stable C ABI for the on-device LLM engine consumed by the Syni SDKs (Flutter, Swift, Kotlin)

- [Syni Spec Overview](/syni-spec/overview.md): The canonical behavioral and safety specification for Syni
- [Syni Spec Install](/syni-spec/install.md): How syni-spec is distributed, and how SDKs consume it

- [Synheart Session Overview](/synheart-session/overview.md): Real-time session capture with on-device HR metrics and behavioral signal fusion across phone and watch
- [Session Lifecycle](/synheart-session/lifecycle.md): Session state machine, ownership, and watch / phone fallback semantics
- [Session Providers](/synheart-session/providers.md): BiosignalProvider and BehaviorProvider — the two pluggable data sources the engine consumes
- [Session Watch Protocol](/synheart-session/watch-protocol.md): Phone↔watch wire format (session.proto), transport mapping, and raw streaming opt-in
- [Synheart Session - Flutter SDK](/synheart-session/flutter.md): Flutter SDK with stream-based session API for HR metrics and behavioral signals
- [Synheart Session - Kotlin SDK](/synheart-session/kotlin.md): Native Kotlin SDK for Android with on-device SessionEngine and pluggable providers
- [Synheart Session - Swift SDK](/synheart-session/swift.md): Native Swift SDK for iOS and watchOS with on-device SessionEngine and pluggable providers
- [Session Errors](/synheart-session/errors.md): SessionError event codes, exception classes, and recovery paths

- [RAMEN Overview](/ramen/overview.md): Real-time event delivery backplane — how clients subscribe to vendor and platform events
- [Lab Mode Overview](/lab/overview.md): Research surface for recording structured experiment data alongside the live HSI loop
- [Synheart Sensor Agent Overview](/synheart-sensor-agent/overview.md): Privacy-first PC background sensor for behavioral research from keyboard and mouse interactions

- [Behavior SDK Privacy Audit](/privacy/behavior.md): Privacy properties of the Synheart Behavior SDK — what is and is not collected

- [Guides Overview](/guides/overview.md): Comprehensive guides for using Synheart
- [How It Fits Together](/guides/how-it-fits-together.md): Mental model of the Synheart stack — runtime, services, dashboard
- [Implementing Consent](/guides/consent.md): Wiring consent into your app — Synheart consent vs OS permissions and the required order
- [Runtime Configuration](/guides/runtime-config.md): Configure the Synheart Core runtime — initialization, modules, and cloud connectivity
- [Testing](/guides/testing.md): Test apps that use the Synheart SDKs — mocks, fixtures, integration patterns
- [Glossary](/guides/glossary.md): Synheart vocabulary — HSI, HSV, biosignals, consent tiers, and more
- [Troubleshooting](/guides/troubleshooting.md): Common issues and solutions for Synheart SDKs
- [FAQ](/guides/faq.md): Frequently asked questions about Synheart SDKs

## Optional

- [Platform](https://platform.synheart.ai): Synheart platform dashboard.
- [GitHub](https://github.com/synheart-ai)
- [Feedback](https://feedback.synheart.ai)