Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.synheart.ai/llms.txt

Use this file to discover all available pages before exploring further.

synheart-platform is the web console at platform.synheart.ai. It’s where you create an organization, work inside tenants and projects, register Apps, generate API keys, and inspect the sessions and biosignals your integrations produce. If you’re using any cloud-backed Synheart feature — installing the runtime, ingesting biosignals, viewing analytics — your CLI and SDKs authenticate against this platform.
The platform is invite-only today. Request access before continuing.

​
What it owns

  • Identity & access — sign-in, organizations, tenants, members, and invitations.
  • Developer portal — register apps, manage projects and the devices that feed them.
  • API keys — issue, scope, rotate, and revoke keys used by the SDKs and your own backend.
  • Session data — sessions, biosignals, and emotion events your apps produce surface here once ingested.
  • Ingestion allowlisting — Synheart approves which apps may stream biosignals; approved apps can use their key against the ingestion endpoints.

​
What it does not own

  • On-device intelligence — the HSI runtime and the Synheart SDKs run in your app, not on the platform. See Synheart Core.
  • Device adapters — biometrics are captured by Synheart Wear.
  • Crypto and signing — handled by Synheart Auth.

​
The hierarchy

Resources nest from the account boundary down to individual apps. From the outside in: 
Organization
  └── Tenant
        └── Project
              ├── Apps
              ├── Wearables (devices)
              └── Sessions (usage + biosignals)
  • Organization — The top-level account for your company or business. It manages billing, members, permissions, and every resource underneath it.
  • Tenant — An isolated workspace inside the organization—often a department, client, environment, or business unit. Each tenant keeps its data and configuration separated from others.
  • Project — A logical grouping inside a tenant for applications, services, and configuration tied to one product or initiative.
  • App — A mobile or web application registered on the platform. The dashboard assigns each App a platform app_id (a short code such as app_focus_and_kB8mPx); integrations, attestation, and API keys are configured at the app level.
  • Wearable — A device assigned to a project (Apple Watch, Garmin, Fitbit, etc.).
  • Session — A single usage event with timestamps, biosignals, and emotion events.
API keys are minted per app and owned by an organization. Access checks run against your org membership and project ownership.

​
How it fits with the rest

CLI

synheart login signs the CLI in to your platform account via OAuth Device Flow.

Synheart Core

The runtime fetches its native artifacts from the platform registry once you’re authenticated.

Synheart Auth

Devices register against the platform’s auth service and sign every outbound request.

Synheart Session

Sessions you record on-device surface in the platform once ingestion is approved.

​
Reading order

Developer portal

Sign in, create an org, register apps.

API keys

Generate, scope, rotate, and revoke per-app keys for the SDKs and your backend.

App attestation

Verify real, unmodified apps with Play Integrity (Android) and App Attest (iOS).

Projects & wearables

Organize apps, devices, and sessions inside a project.