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.

The developer portal is the part of platform.synheart.ai where you set up your organization, register apps, and request the access your integration needs. Plan to finish onboarding here before pointing the CLI or SDKs at the platform.

Sign in

Sign in at platform.synheart.ai using your invite. The platform supports:
  • Email + password
  • OAuth providers (Google, GitHub)
The same credentials authenticate the CLI via OAuth Device Flow. See Authenticate the CLI.

Create an organization

First-time users land in onboarding and create an organization — the top-level account for your company or business. It owns billing, members, permissions, and all resources below it. Each organization holds:
  • Tenants — isolated workspaces (for example departments, clients, environments, or business units). Projects belong to a tenant, and each tenant keeps its data and configuration separated.
  • Members — users invited into the org.
  • Projects — see Projects & wearables.
You can switch between organizations from the org selector in the dashboard header. The selected org is sent as the X-Org-ID header on every dashboard API call, so be sure you’re in the right context before generating keys or registering apps.

Invite teammates

Invite collaborators from your organization settings. Invitations are email-based and accepted by signing in to the same platform account.

Register an app

An App is one mobile or web application connected to the platform — where you configure integrations, attestation, and API access. Apps live inside a project: pick or create the project first, then register the app from inside it. The dashboard assigns each App a platform app_id — a short code such as app_focus_and_kB8mPx. This is the Synheart identifier for the App record (used in API keys, errors, and support). Your Android packageName / iOS bundle ID are separate values that you also configure on the App; do not assume they are the same string.

Ingestion access

Generating an API key works for any app you own, but biosignal ingestion is gated by an app-level allowlist maintained by Synheart. Keys for apps that aren’t on the list are rejected at ingestion time. There’s no self-service request flow in the portal today — contact Synheart with the platform app_id if you need ingestion access. The first-party Synheart mobile app is allowlisted by default.

Next

API keys

Generate per-app keys and learn how to scope them.

Projects & wearables

Set up projects under a tenant: apps, devices, and sessions.