Getting started

Pick the surface you prefer; they all drive the same routes.

Surface	Best for	Start
Studio	Seeing what a project is, clicking through the lifecycle	Quickstart: Studio
hcloud (CLI)	Scripts, terminals, CI	Quickstart: hcloud
curl	Understanding the HTTP contract	Quickstart: curl
@hyphae/cloud (JavaScript)	Applications	Quickstart: JavaScript

The five ideas you need

1. A project is one engine. Creating a project reserves a name and a loopback port; nothing runs until you wake it up. Sleeping stops the process and keeps the data directory. → One Native per project, Lifecycle
2. Two credentials. Your session (hyc0_…, 24 h, from login) manages projects. A project key (hyp1_…) is what an application uses on the data plane. Keys are shown once and checked on every request. → Credentials
3. The data plane is Native’s own API. /v2/* is forwarded verbatim to your engine; the Cloud does not rewrite it. The Studio decodes one response kind (capabilities) and shows the engine’s field names unchanged. → Native fields
4. Snapshots are Native backups, taken on a sleeping project; restore replaces the directory. → Snapshots and restore
5. Storage, realtime and functions are Cloud services next to the engine: a blob catalog, an in-process event fanout, and time-boxed processes running your own code. Each has clear limits and non-claims. → Storage, Realtime, Functions and secrets

Where things live

• Public origin: https://infra-hyphae.run (API and the Studio at /studio/). These docs are published at https://hyphae.dev/cloud/docs/.
• Control plane: /v0/* — accounts, projects, keys, snapshots, storage catalog, realtime, functions.
• Data plane: /v2/* — your engine, through the Cloud’s proxy, with a project key.
• Health: /healthz, /readyz (no credentials).

The full route list is generated from the contract: HTTP API reference.