Platform API overview

The engine-agnostic surface of HELIX — identity, economy, storage, inventory, and social — exposed identically on every runtime.

The Platform API is the part of HELIX that has nothing to do with rendering. It's the same on web and Native, with the same function names and the same guarantees. These pages describe the semantics — what each capability does, what the server guarantees, and what the error cases are. Runtime-specific signatures live in each runtime's reference, linked from every page.

How to read these pages

Each Platform API page is language-neutral. Code samples use the runtime tabs you've seen — pick your runtime once and it sticks. The Web (TS) signature is canonical; other runtimes mirror it.

The surface

Authentication & Identity

One account across every world. Launch tickets, sessions, guests, profiles.

LIX & Economy

The wallet, purchases, the marketplace, and in-world purchases.

Cloud Save

Durable, authoritative per-world key–value storage.

Memory Store

Volatile, low-latency, TTL'd state shared across instances.

Inventory & Items

Universal items and the four-tier execution model.

Social & Presence

Friends, presence, and invites.

The `Helix` namespace

On every runtime, the platform is reached through a single Helix object. The full set:

Helix.auth        Helix.profile     Helix.avatar      Helix.world
Helix.instance    Helix.network     Helix.social      Helix.chat
Helix.voice       Helix.wallet      Helix.inventory   Helix.marketplace
Helix.cloudSave   Helix.memoryStore Helix.assets      Helix.analytics
Helix.moderation  Helix.ui

Initialize it once at startup:

await Helix.init({ worldId, launchTicket });

Two rules that run through everything

1. The server owns value

Anything affecting inventory, currency, or ownership is server-authoritative. Clients are trusted only for visuals and local gameplay. See the Universal Item Contract.

2. Storage has two tiers

Cloud Save is durable and authoritative — the source of truth. Memory Store is volatile, fast, and always requires a TTL — never the source of truth. Don't reach for one when you mean the other.