# Elata Docs

> Documentation, learning, and information hub for the Elata platform and ecosystem.

## Overview

### Start Here

- [Welcome to Elata](https://docs.elata.bio/overview/welcome.md): What Elata is, who it's for, and how to find your way around these docs.
- [How Elata Fits Together](https://docs.elata.bio/overview/ecosystem-map.md): The ecosystem map: devices, the Elata SDK, apps, and Elata itself, and how data and value move between them.
- [What's Live](https://docs.elata.bio/overview/status.md): The status of every Elata capability: live, experimental, planned, or retired.
- [Find Your Path](https://docs.elata.bio/overview/find-your-path.md): Suggested reading for users, builders, researchers, partners and investors, and community members.

### The Ecosystem

- [Apps on Elata](https://docs.elata.bio/overview/apps-on-elata.md): What kinds of apps live on Elata, how they're reviewed, and how they run safely in your browser.
- [The Elata SDK](https://docs.elata.bio/overview/elata-sdk.md): Open-source packages that turn webcams and consumer headbands into biosignal sensors, with processing on the user's device.
- [Biosignals Explained](https://docs.elata.bio/overview/biosignals.md): A plain-language guide to camera heart rate, EEG headbands, and headband PPG: what each measures and what it can't tell you.
- [Privacy and Consent](https://docs.elata.bio/overview/privacy-and-consent.md): What stays on your device, what apps can store, how the opt-in biometric Score works, and your rights over your data.
- [Elata Points](https://docs.elata.bio/overview/points.md): Non-transferable points you earn for using, building, and growing Elata.
- [Commercialization](https://docs.elata.bio/overview/monetization.md): What users pay for, how builders earn, and where payments go.
- [ELTA Token](https://docs.elata.bio/overview/elta-token.md): The facts about ELTA: what it is, where it's deployed, and how to verify the official contract.

### Science

- [Science at Elata](https://docs.elata.bio/overview/science/overview.md): Elata's scientific stance: what the measurements are for, how claims are graded, and where to read more.
- [Camera Heart Rate (rPPG)](https://docs.elata.bio/overview/science/rppg.md): How a webcam estimates pulse, how the Elata SDK does it, and the conditions that limit accuracy.
- [EEG Headbands](https://docs.elata.bio/overview/science/eeg.md): What consumer EEG headbands measure, how the Elata SDK processes it, and what calm and focus scores can and can't claim.
- [PPG and Heart-Rate Variability](https://docs.elata.bio/overview/science/ppg-and-hrv.md): Optical heart rate from a headband, heart-rate variability, and the conditions that make HRV meaningful.
- [Metrics and Scores](https://docs.elata.bio/overview/science/metrics-and-scores.md): How Elata turns signals into features and scores, why scores withhold themselves, and how the biometric Score is built.
- [Data for Research](https://docs.elata.bio/overview/science/data-for-research.md): What biosignal data exists in the Elata ecosystem, what doesn't, and the tools available for running your own studies.
- [Research Directions](https://docs.elata.bio/overview/science/research-directions.md): Planned research directions and earlier research projects, each clearly labelled.

### Community

- [Mission and History](https://docs.elata.bio/overview/mission-and-history.md): Why Elata exists, and the public milestones that got it here.
- [Community](https://docs.elata.bio/overview/community.md): Where to find the Elata community, how to give feedback, and how to contribute.
- [Partners](https://docs.elata.bio/overview/partners.md): What Elata is today, and how device makers, researchers, and app studios can work with us.
- [Media & Branding Assets](https://docs.elata.bio/resources/media-assets.md): Elata logos, logotypes, and brand assets.
- [FAQ](https://docs.elata.bio/resources/faq.md): Answers to common questions about Elata, its apps, the Elata SDK, privacy, points, and the ELTA token.
- [Glossary](https://docs.elata.bio/overview/glossary.md): Plain-language definitions of the terms used across the Elata docs.

## Using Elata

### Using Elata

- [Get Started](https://docs.elata.bio/users/get-started.md): Open Elata, sign in, and try your first biosignal app in a few minutes.
- [Explore Apps](https://docs.elata.bio/users/explore-apps.md): Find, play, and save apps on Elata.
- [Devices You Can Use](https://docs.elata.bio/users/devices.md): What you need for camera, EEG, and headband heart-rate apps, which browsers work, and how to get a clean reading.
- [Score and Insights](https://docs.elata.bio/users/score-and-insights.md): The optional biometric Score from your side: how to turn it on, what it reflects, and how to turn it off.
- [Local Sessions and Insights](https://docs.elata.bio/users/local-sessions-and-insights.md): The experimental on-device recording flow, its storage controls, and how it differs from cloud app records.
- [Your Data](https://docs.elata.bio/users/your-data.md): What stays on your device, what apps and Elata keep, and how to access, export, or delete your data.
- [Points and Quests](https://docs.elata.bio/users/points-and-quests.md): A practical guide to earning Elata Points, completing quests, and climbing the leaderboard.
- [Billing and Purchases](https://docs.elata.bio/users/billing-and-purchases.md): Buy app items, manage monthly access, and understand your wallet and credits.
- [Safety and Limitations](https://docs.elata.bio/users/safety-and-limitations.md): What Elata apps can and can't tell you, and how to use them safely.
- [Help](https://docs.elata.bio/users/help.md): Where to get support, give feedback, and report a problem with an app.

## Build Apps

### Start Here

- [What Are Elata Apps?](https://docs.elata.bio/apps/what-are-elata-apps.md): Browser apps built on the Elata SDK and published to Elata.
- [Quickstart](https://docs.elata.bio/apps/quickstart.md): Build a biosignal app and publish it to Elata.
- [What You Can Build](https://docs.elata.bio/apps/what-you-can-build.md): App categories, example ideas, and the biosignals you can build with.
- [App Lifecycle](https://docs.elata.bio/apps/app-lifecycle.md): How an app goes from upload to a live, publicly playable listing.
- [Choose Your Path](https://docs.elata.bio/apps/choose-your-path.md): Whether you want to build an app or use one, start here.

### Build

- [Builder Overview](https://docs.elata.bio/apps/build/overview.md): What Elata gives you and what you avoid building yourself.
- [Requirements](https://docs.elata.bio/apps/build/requirements.md): What your app needs before you upload and submit it.
- [Publish Your App](https://docs.elata.bio/apps/build/launch-your-app.md): Step-by-step through the Build an App wizard, from registration to submitting for review.
- [elata.json](https://docs.elata.bio/apps/build/elata-json.md): The app manifest that declares your release version.
- [Upload and Hosting](https://docs.elata.bio/apps/build/upload-and-hosting.md): Upload limits, self-hosted URLs, the sandbox your app runs in, and home-screen install.
- [App Listing](https://docs.elata.bio/apps/build/app-metadata.md): The fields and images that make up your app's page on Elata.
- [Review and Policy](https://docs.elata.bio/apps/build/review-and-policy.md): What the automated scan and moderators check before an app goes live.
- [Monetize Your App](https://docs.elata.bio/apps/build/monetize.md): Configure products and subscriptions, track sales, and access your proceeds.
- [Post-Launch Checklist](https://docs.elata.bio/apps/build/post-launch-checklist.md): What to do once your app is live on Elata.

### Platform APIs

- [Host Bridge](https://docs.elata.bio/apps/platform/host-bridge.md): How your sandboxed app talks to Elata, and every message it supports.
- [In-App Purchases](https://docs.elata.bio/apps/platform/in-app-purchases.md): Sell one-time items in your app with @elata-biosciences/app-payments.
- [App State](https://docs.elata.bio/apps/platform/app-state.md): Per-user, per-app key-value storage with @elata-biosciences/app-state.
- [Metrics and Scores](https://docs.elata.bio/apps/platform/metrics-and-scores.md): Record events and scores, and contribute to the biometric Score, with @elata-biosciences/app-metrics.
- [Consent and Insights](https://docs.elata.bio/apps/platform/consent-and-insights.md): Ask for biometric data-sharing consent and read a user's cross-app insights.
- [Notifications](https://docs.elata.bio/apps/platform/notifications.md): Show reminders to users through Elata while your app is open.
- [Subscriptions](https://docs.elata.bio/apps/platform/subscriptions.md): Configure monthly app access, trials, and manual renewal through Elata.

### Operate

- [Grow Your Community](https://docs.elata.bio/apps/operate/grow-your-community.md): A practical playbook for getting players to your app and keeping them.
- [Revenue and Payouts](https://docs.elata.bio/apps/operate/revenue-and-payouts.md): Understand your sales reports, access your payout wallet, and move your USDC.
- [Analytics](https://docs.elata.bio/apps/operate/analytics-and-health.md): The usage analytics Elata gives you, and how to get the most from them.

### AI Guide

- [Claude Code](https://docs.elata.bio/apps/ai-tools/claude-code.md): Use Claude Code to build Elata apps with the Elata SDK and Elata APIs.
- [Cursor](https://docs.elata.bio/apps/ai-tools/cursor.md): Use Cursor to build Elata apps with the Elata SDK and Elata APIs.
- [Windsurf](https://docs.elata.bio/apps/ai-tools/windsurf.md): Use Windsurf to build Elata apps with the Elata SDK and Elata APIs.

## Elata SDK

### Overview

- [Getting Started](https://docs.elata.bio/sdk/overview.md): Browser SDKs for camera rPPG, EEG over Web Bluetooth, headband PPG, session recording, and analytics.
- [Create Elata Demo](https://docs.elata.bio/sdk/create-elata-demo.md): Scaffold a ready-to-run Elata starter app from a template.

#### Device Integration

- [Integrate your device with the Elata SDK](https://docs.elata.bio/integrate.md): Integrate a headset or biosignal device into the Elata EEG BLE stack with a simple, reliable path.
- [Integration Paths](https://docs.elata.bio/integration-paths.md): Choose the right packaging and ownership model for a device integration.
- [Transport Contract](https://docs.elata.bio/transport-contract.md): Implement the shared Elata transport and frame interfaces for your device.
- [Protocol Requirements](https://docs.elata.bio/protocol-requirements.md): Collect the protocol, BLE, and metadata details needed before coding a device adapter.
- [Adapter Implementation](https://docs.elata.bio/adapter-implementation.md): Build a device adapter that plugs into BleTransport and emits stable headband frames.
- [Testing and Validation](https://docs.elata.bio/testing-and-validation.md): Validate frame correctness, lifecycle behavior, and failure handling before shipping a device integration.
- [Submission and Support](https://docs.elata.bio/submission-and-support.md): Package a device integration with the docs, caveats, and support details needed for a clean handoff.

#### Guides

- [Choosing the right package](https://docs.elata.bio/sdk/guides/choose-the-right-package.md): Pick the right Elata SDK package for what you're building.
- [Remote sensing in a browser App](https://docs.elata.bio/sdk/guides/rppg-browser.md): Add browser-based camera rPPG with the supported Elata session helpers.
- [EEG in a browser App](https://docs.elata.bio/sdk/guides/eeg-browser.md): Add Elata EEG WASM APIs to an existing browser application.
- [Web Bluetooth with supported devices](https://docs.elata.bio/sdk/guides/web-bluetooth.md): Stream Muse-compatible EEG devices from supported Chromium browsers.
- [EEG + BLE integration](https://docs.elata.bio/sdk/guides/eeg-ble-integration.md): Connect a Muse-compatible headband in the browser, stream EEG frames, and compute band powers with the Elata SDK.
- [Camera Integration](https://docs.elata.bio/sdk/guides/rppg-camera.md): Add camera-based heart rate to a browser app with the Elata rPPG Web SDK.
- [Example Applications](https://docs.elata.bio/sdk/guides/example-apps.md): Open source browser apps built with Elata EEG, Web Bluetooth, and rPPG packages.

#### Tutorials

- [Build your first Elata App](https://docs.elata.bio/sdk/tutorials/first-app.md): Scaffold a working app first, then use it as the reference point for deeper SDK integration.
- [Add EEG to an existing browser app](https://docs.elata.bio/sdk/tutorials/eeg-existing-app.md): Step by step, wire Elata EEG processing into a browser app and verify the WASM path works.
- [Stream EEG over Web Bluetooth](https://docs.elata.bio/sdk/tutorials/eeg-ble-live-stream.md): Build a browser EEG flow that discovers a supported device, connects, and starts receiving frames.
- [Add camera-based rPPG to an existing browser App](https://docs.elata.bio/sdk/tutorials/rppg-existing-app.md): Build a working browser rPPG flow with createRppgSession, diagnostics, and cleanup.

### EEG Web SDK

- [Getting Started](https://docs.elata.bio/sdk/eeg-web/getting-started.md): Install and initialize the @elata-biosciences/eeg-web WASM package
- [Headband Transport](https://docs.elata.bio/sdk/eeg-web/headband-transport.md): Normalized frame schema and transport interface for EEG headband devices
- [Analysis Models](https://docs.elata.bio/sdk/eeg-web/models.md): Alpha bump detection, alpha peak tracking, and calmness scoring
- [Signal Processing](https://docs.elata.bio/sdk/eeg-web/signal-processing.md): Band power analysis, FFT, and spectrum computation

### EEG BLE Web SDK

- [Getting Started](https://docs.elata.bio/sdk/eeg-web-ble/getting-started.md): Connect to EEG headband devices over Web Bluetooth
- [Muse Device](https://docs.elata.bio/sdk/eeg-web-ble/muse-device.md): MuseBleDevice internals, protocol details, and compatibility

### Camera Web SDK

- [Getting Started](https://docs.elata.bio/sdk/rppg-web/getting-started.md): Camera-based heart rate measurement with @elata-biosciences/rppg-web
- [Frame Sources](https://docs.elata.bio/sdk/rppg-web/frame-sources.md): Camera capture and face detection with MediaPipe
- [Calibration & Fusion](https://docs.elata.bio/sdk/rppg-web/calibration.md): Muse PPG calibration and multi-source heart rate fusion

### PPG Web SDK

- [Getting Started](https://docs.elata.bio/sdk/ppg-web/getting-started.md): Heart rate and HRV from a Muse headband's optical (PPG) sensor with @elata-biosciences/ppg-web.

### Sessions and Analytics

- [Getting Started](https://docs.elata.bio/sdk/biosignal-session/getting-started.md): Record multi-sensor biosignal sessions locally with @elata-biosciences/biosignal-session.
- [Getting Started](https://docs.elata.bio/sdk/biosignal-analytics/getting-started.md): EEG features, HRV, robust statistics, and transparent headline scores with @elata-biosciences/biosignal-analytics.

### Operations

- [Compatibility](https://docs.elata.bio/sdk/operations/compatibility.md): Current browser, device, and Node.js expectations for the Elata SDK.
- [Troubleshooting](https://docs.elata.bio/sdk/operations/troubleshooting.md): Common setup failures and the fastest checks for Elata SDK integrations.

### Contributors

- [Contributing EEG Transports](https://docs.elata.bio/sdk/maintainers/contributing-eeg-transports.md): How to add headset transports beyond the built-in Muse path for the Elata browser EEG stack.
- [Vendor Headset Onboarding Checklist](https://docs.elata.bio/sdk/maintainers/vendor-headset-onboarding.md): Step-by-step checklist for external device companies adding headset support to the Elata browser EEG stack.

## Archive

### About the Archive

- [About the Archive](https://docs.elata.bio/archive/overview.md): Earlier Elata projects and retired features, kept for reference.

### AgentForge

- [AgentForge Overview](https://docs.elata.bio/open-source/agentforge/overview.md): Adversarial, agent-based simulation of EVM mechanisms
- [Core Concepts](https://docs.elata.bio/open-source/agentforge/concepts.md): Scenarios, agents, ticks, packs, and determinism in AgentForge
- [CLI Reference](https://docs.elata.bio/open-source/agentforge/cli.md): Full command and option reference for the AgentForge CLI
- [Studio Dashboard](https://docs.elata.bio/open-source/agentforge/studio.md): Multi-run analysis dashboard with charts, gossip analysis, and ML toolkit

### NewsReader

- [Newsreader Overview](https://docs.elata.bio/open-source/newsreader/overview.md): AI-powered environmental scanner for the Elata DAO — news.elata.bio
- [Newsreader Architecture](https://docs.elata.bio/open-source/newsreader/architecture.md): How the AI-powered scraper pipeline works

### Zorp Protocol

- [Introduction](https://docs.elata.bio/zorp-protocol/zorp-intro.md): An archived Elata open-source project: the ZORP protocol.
- [How ZORP works](https://docs.elata.bio/zorp-protocol/zorp-function.md): How the archived ZORP protocol works.

### Elata EEG

- [Elata EEG Overview](https://docs.elata.bio/home/elata-eeg/elata-eeg-overview.md): Open-source, low-cost EEG hardware for precision psychiatry and neuroscience research
- [EEG Architecture](https://docs.elata.bio/home/elata-eeg/eeg-architecture.md): Crate layering, plugin system, WebSocket API, and board configurations

## Optional

- [Contact](https://airtable.com/appttqOzZRQ5F9hFh/shrj1wM1xRKS8FUdk)
- [Blog](https://elata.bio/blog)
- [Discord Community](https://discord.com/invite/GqS9CstffK)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [Chinese (108 pages)](https://docs.elata.bio/_llms/cn.txt): Documentation for Chinese.
- [Spanish (108 pages)](https://docs.elata.bio/_llms/es.txt): Documentation for Spanish.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.