# Sylphx

> Sylphx is one platform — hosting, databases, auth, AI, sandboxes, events, observability, builds, CI runners, and networking — behind one account, one API (https://api.sylphx.com), one API key, one SDK per language, one CLI, one MCP server, and one bill. Products today: 18 products, one key.

Authenticate every call with one Access key (`sylphx_sk_…`) in `Authorization: Bearer`, or set `SYLPHX_API_KEY` for the SDK and CLI. A key is scoped to one environment and to the services it names.

## Start

- [Documentation](https://sylphx.com/docs): get started, keys, and every service
- [Pricing](https://sylphx.com/pricing.md): the plans; prices are published when billing opens
- [TypeScript SDK](https://www.npmjs.com/package/@sylphx/sdk): `npm install @sylphx/sdk`, one client with every service on it
- [CLI and MCP server](https://github.com/SylphxAI/sylphx-clients): `npm install -g @sylphx/cli`, then `sylphx login`; `sylphx mcp` serves every API method as an MCP tool

## Services

- [Sylphx Hosting](https://sylphx.com/hosting.md): From a git push to a live URL, with a preview for every pull request. Available: Hosting.
- [Sylphx Data](https://sylphx.com/data.md): Postgres, key-value, object storage, and search. One isolated store per resource. Available: Database, KV, Search.
- [Sylphx Auth](https://sylphx.com/auth.md): Sign-in for your app’s users: passkeys, social, SSO, and organizations. Available: Auth.
- [Sylphx AI](https://sylphx.com/ai.md): One API for frontier models, in the OpenAI and Anthropic formats. Available: AI.
- [Sylphx Workflows](https://sylphx.com/workflows.md): Durable runs, schedules, and timers that call your own HTTP endpoints. Available: Jobs and cron.
- [Sylphx Sandboxes](https://sylphx.com/sandboxes.md): Isolated machines for agents: microVMs, browsers, and desktops. E2B-compatible. Available: Sandboxes.
- [Sylphx Events](https://sylphx.com/events.md): An event bus, queues, webhooks in and out, and realtime channels. Available: Webhooks.
- [Sylphx Realtime](https://sylphx.com/realtime.md): A channel protocol for live updates, presence, and cursor recovery.
- [Sylphx Notify](https://sylphx.com/notify.md): Email, SMS, push, and an in-app inbox, with your users’ preferences. Available: Email.
- [Sylphx Localization](https://sylphx.com/localization.md): Translate your app in CI with AI, a translation memory, and a glossary.
- [Sylphx Generated Assets](https://sylphx.com/assets.md): Declare images in code; they are generated once, locked, and served from a CDN by content hash.
- [Sylphx Analytics](https://sylphx.com/analytics.md): Product and game events from every app, counted once.
- [Sylphx Knowledge](https://sylphx.com/knowledge.md): One knowledge graph your people, apps and agents write as they work and search with citations.
- [Sylphx Observability](https://sylphx.com/observability.md): Logs, traces, errors, and audit for everything you run. Available: Monitoring.
- [Sylphx Build](https://sylphx.com/build.md): Builds with no Dockerfile, a warm cache, and signed provenance. Available: Builds.
- [Sylphx Runners](https://sylphx.com/runners.md): GitHub Actions runners: one clean machine per job. Available: Runners.
- [Sylphx Network](https://sylphx.com/network.md): Domains, certificates, routes, and fixed egress addresses. Available: Network.
- [Sylphx Money](https://sylphx.com/money.md): Sell to your own users: store purchases, subscriptions, and entitlements on one ledger.

## Related products

- [Spiron](https://spiron.ai/): the cloud agent platform

## Optional

- [Security](https://sylphx.com/security)
- [Vulnerability disclosure](https://sylphx.com/security/disclosure)
- [Terms](https://sylphx.com/legal/terms)
- [Privacy](https://sylphx.com/legal/privacy)
- [Changelog](https://sylphx.com/changelog)
- [Changelog feed](https://sylphx.com/changelog/feed.xml)
- [Status](https://status.sylphx.com/)

---

# Sylphx Hosting

> From a git push to a live URL, with a preview for every pull request.

Available: Hosting.

Sylphx Hosting is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to Vercel, Render.

## Capabilities

- **Git to release.** A push builds through Sylphx Build and becomes an immutable Release of your service, with sylphx.toml read at that exact commit.
- **A preview per pull request.** Every pull request gets its own environment and URL, torn down when it closes.
- **Scale to zero.** An idle service scales to zero and wakes on the next request. A stale generation is refused at write.
- Every service answers on a *.sylphx.app host at once; bring a domain through Sylphx Network.
- Billed by active vCPU time and resident memory; no idle-CPU charge.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()
const me = await sylphx.access.whoami({})

for await (const item of sylphx.hosting.services.listAll({ parent: me.env! })) {
  console.log(item.name)
}
```

```sh
sylphx hosting services list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs/deploy)
- [Start](https://sylphx.com/signup?service=hosting)

---

# Sylphx Data

> Postgres, key-value, object storage, and search. One isolated store per resource.

Available: Database, KV, Search.

Sylphx Data is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to Neon, Upstash.

## Capabilities

- **Postgres.** A pooled and a direct connection URL, a database per preview, and point-in-time restore. An idle free database stops and the next connection wakes it.
- **Key-value and objects.** Versioned key-value in its own store, and object buckets with versions, multipart uploads, private-by-default visibility, and share links.
- **Search.** Lexical and vector search on the index’s own engine, with deterministic ordering.
- Every database, key-value store, bucket, and index is its own store with its own credentials and backups — never rows in a shared table.
- Moves between sizes and regions keep the same URL.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()
const me = await sylphx.access.whoami({})

for await (const item of sylphx.data.databases.listAll({ parent: me.env! })) {
  console.log(item.name)
}
```

```sh
sylphx data databases list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs/database)
- [Start](https://sylphx.com/signup?service=data)

---

# Sylphx Auth

> Sign-in for your app’s users: passkeys, social, SSO, and organizations.

Available: Auth.

Sylphx Auth is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to Clerk, Auth0.

## Capabilities

- **Every sign-in method.** Passkeys, magic links, email codes, passwords with MFA and breach checks, and social sign-in through OIDC.
- **Organizations and SSO.** Your customers’ organizations with roles and verified domains, and inbound SAML for their identity providers.
- **Hosted and white-labelled.** A hosted account portal on your own domain, React components, and an OAuth server with PKCE and the device flow.
- Progressive lockout, session limits, and revocation signals are built in.
- Billed per monthly active user.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()
const me = await sylphx.access.whoami({})

for await (const item of sylphx.auth.endUsers.listAll({ parent: me.env! })) {
  console.log(item.name)
}
```

```sh
sylphx auth end-users list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs/auth)
- [Start](https://sylphx.com/signup?service=auth)

---

# Sylphx AI

> One API for frontier models, in the OpenAI and Anthropic formats.

Available: AI.

Sylphx AI is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to OpenRouter.

## Capabilities

- **The formats you already use.** Responses, Chat Completions, and Anthropic Messages on api.sylphx.ai, with streaming, tools, and stored responses.
- **The model you asked for.** A request for a model is served by that model. The catalog lists the newest stable release of each line, with its price.
- **Prompt caching.** Cached input is reported and priced at the model’s cached-input list price.
- Hosted web search, fetch, and tool search run inside the request.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()

for await (const item of sylphx.ai.aiModels.listAll({})) {
  console.log(item.name)
}
```

```sh
sylphx ai ai-models list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs/ai)
- [Start](https://sylphx.com/signup?service=ai)

---

# Sylphx Agents

> A hosted agent runtime: versioned agents, durable sessions, memory, and a governed tool gateway.

Available: Agents.

Sylphx Agents is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to AWS Bedrock AgentCore, Claude Managed Agents.

## Capabilities

- **Versioned agents.** An agent is a model, instructions, tools, MCP servers, skills, and memory stores. Every change is a new immutable version, and a session pins the one it started on.
- **Durable sessions.** Each session keeps an append-only event log. Send, steer, interrupt, and answer approvals; each turn runs as a durable workflow, and an idle session holds no compute.
- **Governed tools and memory.** Every tool call passes a policy and gets its credential injected at egress, so the model never sees it. Long-term memory is recalled by full-text and vector search.
- Not served yet: the API is in the schema and the SDKs, and answers 501 until launch.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()
const me = await sylphx.access.whoami({})

for await (const item of sylphx.agents.agents.listAll({ parent: me.env! })) {
  console.log(item.name)
}
```

```sh
sylphx agents agents list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs)
- [Start](https://sylphx.com/signup?service=agents)

---

# Sylphx Workflows

> Durable runs, schedules, and timers that call your own HTTP endpoints.

Available: Jobs and cron.

Sylphx Workflows is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to Temporal, Trigger.dev.

## Capabilities

- **Runs that finish.** A run started with an idempotency key happens once. It ends only from a recorded step result or a cancellation, and an unknown result is reconciled, never re-sent.
- **Schedules and timers.** Cron or rate schedules with time zones, overlap and catch-up rules. Every sleep and deadline is a durable timer.
- **No workers to run.** Each step calls your endpoint with a short-lived signed token, even a service scaled to zero. Built on Temporal.
- Every run keeps a bounded, paged history.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()
const me = await sylphx.access.whoami({})

for await (const item of sylphx.workflows.workflows.listAll({ parent: me.env! })) {
  console.log(item.name)
}
```

```sh
sylphx workflows workflows list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs)
- [Start](https://sylphx.com/signup?service=workflows)

---

# Sylphx Sandboxes

> Isolated machines for agents: microVMs, browsers, and desktops. E2B-compatible.

Available: Sandboxes.

Sylphx Sandboxes is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to E2B.

## Capabilities

- **A machine per lease.** A microVM with exec, files, and processes, granted at once or refused with a reason, and wiped when released.
- **Browsers and desktops.** Chrome over CDP and computer-use desktops, with a live viewer and human takeover that holds the agent off until it ends.
- **Bounded and compatible.** Egress policies, time and cost budgets, volumes, and snapshots. E2B SDK clients work unchanged.
- Every grant, end, and control change is an ordered event, delivered as a signed webhook.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()
const me = await sylphx.access.whoami({})

for await (const item of sylphx.sandboxes.leases.listAll({ parent: me.env! })) {
  console.log(item.name)
}
```

```sh
sylphx sandboxes leases list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs)
- [Start](https://sylphx.com/signup?service=sandboxes)

---

# Sylphx Events

> An event bus, queues, webhooks in and out, and realtime channels.

Available: Webhooks.

Sylphx Events is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to EventBridge, Svix.

## Capabilities

- **Publish once, fan out.** CloudEvents deduplicated by source and id, fanned out by subscription to queues, webhooks, or realtime channels.
- **Webhooks both ways.** Signed Standard Webhooks out with retries and receipts; inbound endpoints that verify, deduplicate, and answer in time.
- **Queues and realtime.** Leased queues with dead-lettering and replay, and WebSocket or SSE channels that resume from a cursor.
- Every delivery attempt is an immutable record.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()
const me = await sylphx.access.whoami({})

for await (const item of sylphx.events.topics.listAll({ parent: me.env! })) {
  console.log(item.name)
}
```

```sh
sylphx events topics list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs/webhooks)
- [Start](https://sylphx.com/signup?service=events)

---

# Sylphx Realtime

> A channel protocol for live updates, presence, and cursor recovery.

Sylphx Realtime is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to Ably, Liveblocks.

## Capabilities

- **Channel protocol v1.** The contract defines namespaces, implicit channels, and multiplexed WebSocket or SSE sessions.
- **Scoped client authority.** The contract defines channel capabilities and in-band token refresh.
- **History and recovery rules.** The contract defines bounded history, cursor recovery, and ephemeral namespaces without retained messages.
- Contract only: the gateway is not serving protocol v1 yet. Existing Events channels remain available.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()

for await (const item of sylphx.realtime.namespaces.listAll({})) {
  console.log(item.name)
}
```

```sh
sylphx realtime namespaces list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs)
- [Start](https://sylphx.com/signup?service=realtime)

---

# Sylphx Notify

> Email, SMS, push, and an in-app inbox, with your users’ preferences.

Available: Email.

Sylphx Notify is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to Resend, Knock.

## Capabilities

- **One message, every channel.** A message is admitted once and fans out to the channels a recipient allows, with fallback and digesting.
- **Email done properly.** Verified sending domains, DKIM signing, versioned templates, and suppression on bounces and complaints.
- **Inbox and broadcasts.** An in-app inbox that updates live, and scheduled broadcasts that still honour every preference.
- Each delivery closes with the provider’s receipt.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()
const me = await sylphx.access.whoami({})

for await (const item of sylphx.notify.messages.listAll({ parent: me.env! })) {
  console.log(item.name)
}
```

```sh
sylphx notify messages list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs/email)
- [Start](https://sylphx.com/signup?service=notify)

---

# Sylphx Localization

> Translate your app in CI with AI, a translation memory, and a glossary.

Sylphx Localization is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to Lokalise, Crowdin.

## Capabilities

- **Translate in CI.** Sync your source strings and only new or changed ones are translated. Builds read committed catalogs; nothing translates at run time.
- **Memory and glossary.** Exact matches come from the translation memory, and a glossary fixes brand terms, keeps names untranslated, and forbids wording per locale.
- **QA before export.** Placeholders, plurals, length, and glossary rules are checked, and a translation that fails is never exported. Export also reports the glyphs each locale uses.
- Billed by translated characters; memory reuse, pinned text, and QA are free.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()
const me = await sylphx.access.whoami({})

for await (const item of sylphx.localization.catalogs.listAll({ parent: me.env! })) {
  console.log(item.name)
}
```

```sh
sylphx localization catalogs list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs)
- [Start](https://sylphx.com/signup?service=localization)

---

# Sylphx Generated Assets

> Declare images in code; they are generated once, locked, and served from a CDN by content hash.

Sylphx Generated Assets is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to Scenario, Layer.

## Capabilities

- **Declare, then generate.** A recipe in code has a stable key. Generation runs only when you call it, fills what is missing, and can be called again until nothing is pending.
- **Review and lock.** Approve, reject, or retire each variant. The lock file names exactly the assets your code declares, by content hash, so a build never generates anything.
- **Immutable URLs.** Every file is addressed by the hash of its bytes, so its URL never changes and can be cached for good.
- Billed per image stored; storage, CDN, and the lock are included.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()
const me = await sylphx.access.whoami({})

for await (const item of sylphx.assets.assets.listAll({ parent: me.env! })) {
  console.log(item.name)
}
```

```sh
sylphx assets assets list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs)
- [Start](https://sylphx.com/signup?service=assets)

---

# Sylphx Analytics

> Product and game events from every app, counted once.

Sylphx Analytics is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to PostHog, Mixpanel.

## Capabilities

- **Event batches.** Send events from a page, an app or a game with a publishable key. Each event gets its own result, a resent event is counted once, and one bad event never costs the rest of its batch.
- **Consent and experiments.** A batch carries the app's analytics consent, and nothing is stored until it is granted. Each event can name the experiments its player is in, so results split by variant.
- **Raw event reads.** List an environment's events in a time range, by event name or subject, newest first, to check exactly what arrived.
- Every event is scoped to the organization, project, and environment of the verified key.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()
const me = await sylphx.access.whoami({})

for await (const item of sylphx.analytics.analytics_events.listAll({ parent: me.env! })) {
  console.log(item.name)
}
```

```sh
sylphx analytics analytics_events list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs)
- [Start](https://sylphx.com/signup?service=analytics)

---

# Sylphx Knowledge

> One knowledge graph your people, apps and agents write as they work and search with citations.

Sylphx Knowledge is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to Glean, Zep.

## Capabilities

- **Remember while working.** Notes, messages and step results are recorded as episodes with their source; entities and facts are extracted from them and cite them.
- **Facts with time.** A fact holds from one time to another and is closed, never overwritten, so the graph can be read as it was on any date.
- **Permission-aware recall.** Every record lives in a space, and recall, profiles and answers use only what the caller may read, with citations.
- Contract only: the API is defined, and the service is not served yet.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()
const me = await sylphx.access.whoami({})

for await (const item of sylphx.knowledge.spaces.listAll({ parent: me.env! })) {
  console.log(item.name)
}
```

```sh
sylphx knowledge spaces list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs)
- [Start](https://sylphx.com/signup?service=knowledge)

---

# Sylphx Observability

> Logs, traces, errors, and audit for everything you run.

Available: Monitoring.

Sylphx Observability is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to Sentry.

## Capabilities

- **OpenTelemetry in.** OTLP over gRPC and HTTP for traces, metrics, and logs, with one line of config for every Hosting service.
- **Errors and SLOs.** Errors grouped deterministically, SLOs over your spans, and multi-window burn alerts by email or webhook.
- **Audit you can keep.** An append-only audit chain with legal hold, and retention you set per signal.
- Emitters buffer locally: an outage here never blocks your service.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()
const me = await sylphx.access.whoami({})

for await (const item of sylphx.observability.errorGroups.listAll({ parent: me.env! })) {
  console.log(item.name)
}
```

```sh
sylphx observability error-groups list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs)
- [Start](https://sylphx.com/signup?service=observability)

---

# Sylphx Build

> Builds with no Dockerfile, a warm cache, and signed provenance.

Available: Builds.

Sylphx Build is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to Cloud Build, Depot.

## Capabilities

- **Zero config.** A supported repository builds with no Dockerfile; one that has a Dockerfile is built as written.
- **A warm cache.** A per-project cache makes warm builds faster with byte-identical results.
- **Signed supply chain.** Every image has an SBOM and SLSA provenance signed by a key nobody can read, addressed by digest.
- Each build runs on its own isolated machine, wiped after.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()
const me = await sylphx.access.whoami({})

for await (const item of sylphx.build.builds.listAll({ parent: me.project! })) {
  console.log(item.name)
}
```

```sh
sylphx build builds list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs/deploy)
- [Start](https://sylphx.com/signup?service=build)

---

# Sylphx Runners

> GitHub Actions runners: one clean machine per job.

Available: Runners.

Sylphx Runners is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to Blacksmith, Depot.

## Capabilities

- **Drop-in runners.** Change runs-on to a sylphx-linux-<size> class. Install the Sylphx Runners GitHub App once per organization.
- **One job, one machine.** Each runner gets its own machine for exactly one job, then the machine is wiped.
- **No lost jobs.** Missed webhooks are filled from GitHub’s delivery log, so a queued job always gets a runner.
- Billed per runner minute, by size.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()
const me = await sylphx.access.whoami({})

for await (const item of sylphx.runners.scaleSets.listAll({ parent: me.org! })) {
  console.log(item.name)
}
```

```sh
sylphx runners scale-sets list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs)
- [Start](https://sylphx.com/signup?service=runners)

---

# Sylphx Network

> Domains, certificates, routes, and fixed egress addresses.

Available: Network.

Sylphx Network is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to Cloudflare.

## Capabilities

- **Your domains.** Verify a domain once, then route any host under it. Certificates renew well before expiry.
- **Routes and redirects.** One exact host to one service or a redirect, answered at the edge from its last good configuration.
- **Known egress.** Outbound traffic leaves from declared per-region addresses you can allowlist.
- Billed by internet egress; requests are not metered.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()
const me = await sylphx.access.whoami({})

for await (const item of sylphx.network.domains.listAll({ parent: me.project! })) {
  console.log(item.name)
}
```

```sh
sylphx network domains list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs/configuration)
- [Start](https://sylphx.com/signup?service=network)

---

# Sylphx Money

> Sell to your own users: store purchases, subscriptions, and entitlements on one ledger.

Sylphx Money is a service of Sylphx (preview): the same account, API key, SDK, and bill as every other service. Comparable to RevenueCat, Stripe Billing.

## Capabilities

- **Store purchases, verified.** App Store and Google Play purchases are read back from the store with your own credential, bound to one buyer, and returned as a signed grant your server checks offline.
- **One entitlement check.** Declare features and products once; one call answers whether a user holds a feature, whatever store or card paid for it.
- **Every movement on the ledger.** Purchases, renewals, and refunds post to a double-entry ledger in integer minor units, reversed rather than edited.
- You stay the seller: payments settle in your own store and processor accounts.

## Quickstart

```sh
npm install @sylphx/sdk
```

```ts
import { Sylphx } from '@sylphx/sdk'

// Reads SYLPHX_API_KEY: one key for every Sylphx service.
const sylphx = new Sylphx()
const me = await sylphx.access.whoami({})

for await (const item of sylphx.money.storePurchases.listAll({ parent: me.env! })) {
  console.log(item.name)
}
```

```sh
sylphx money store-purchases list
```

## Pricing

Free while you build. No card required.

## Links

- [Documentation](https://sylphx.com/docs)
- [Start](https://sylphx.com/signup?service=money)

---

# Sylphx pricing

> One free tier, one Pro plan with included usage, per-service meters on one invoice.

## Free

## Pro

Free while you build. No card required.

---

# Full documentation


## API-REFERENCE.md

# Sylphx API reference

The Resource API is served at `https://api.sylphx.com`; every service's
Resources are under it. Its wire source is the
Protobuf schema under [`api/proto`](api/proto); the generated OpenAPI document
is [`docs/api/openapi.json`](docs/api/openapi.json). SDKs, the `sylphx` CLI,
the Terraform provider, and MCP tools are generated from the same schema.
What the API must become is [`docs/vision.md`](docs/vision.md).

The management secret store also supports bodyless
`DELETE /v1/secrets/{sec_id}` and `DELETE /v1/secrets?id=sec_xxx`, alongside
the compatible JSON-body form. See the
[management secret deletion reference](web/content/docs/platform/management-secrets.mdx)
for authorization, audit reasons, force semantics and post-delete reads.

## PLATFORM-USER-GUIDE.md

# Sylphx user guide

Use the `sylphx` CLI or the console at `https://sylphx.com/` against the
Resource API at `https://api.sylphx.com`. `sylphx --help` and the generated
[API reference](API-REFERENCE.md) are the current contract; a command that is
not in the generated contract is not available. What Sylphx is for is
[`docs/vision.md`](docs/vision.md).

## docs/reference/resources.md

# Resource Reference

**Revision:** 2026-08-07
**Binding contract:** Resource, Operation, Event, and Artifact Contract

This file is a concise lookup. It does not define a second Resource model.

## Definition

A Resource is an addressable mutable or lifecycle-managed entity. A retained
fact is an Event; immutable content is an Artifact; an admitted effect is an
Operation.

## Required Resource properties

- strongly typed capability schema;
- canonical hierarchical name and immutable uid;
- one home authority partition and semantic writer;
- opaque etag and explicit generation preconditions;
- typed `spec` and `status` when reconciled;
- bounded generation-aware Conditions;
- typed owner, Policy, sensitivity, retention, and placement class;
- links to Operations, Events, Artifacts, telemetry, cost, and Evidence.

## Standard methods

A Resource exposes the applicable subset of `Get`, `List`, `Create`, `Update`,
`Delete`, `Undelete`, `Plan`, and `Watch`. Domain actions use typed custom
methods and still return Operations.

## Resource name examples

```text
organizations/{organization}
organizations/{organization}/projects/{project}
organizations/{organization}/projects/{project}/services/{service}
organizations/{organization}/projects/{project}/batchJobs/{batch_job}
organizations/{organization}/projects/{project}/buckets/{bucket}
organizations/{organization}/projects/{project}/operations/{operation}
```

Names use product vocabulary. Provider implementation, orchestration, placement,
and scheduling identities are not canonical public names.

## Desired and observed state

- callers and authorized controllers write desired `spec`;
- only the owning authority writes observed `status`;
- `observed_generation` states which desired generation was evaluated;
- `Ready=true` means the customer-visible postcondition was observed;
- history is represented by Events and Operations, not unbounded status arrays.

## Deletion

Deletion fences new incompatible effects, applies typed retention/finalization,
proves external postconditions, emits terminal Event and Evidence Artifact, and
then removes or tombstones the Resource according to policy. Force deletion is
a separate destructive Operation with explicit data-loss and orphan semantics.

## Not Resources

The following are projections or other primitives:

- orchestration objects and provider instances;
- dashboard rows and reports;
- mutable release tags;
- Operation attempts and effect receipts;
- retained domain facts;
- immutable build outputs and evidence bundles.

## docs/reference/database-tiers.md

# Managed Database Service Classes


A database “tier” is not a provider size, billing plan, marketing label, or
mutable string alias. The target uses typed service-class Resources so product,
commercial, and physical concerns remain separate.

## Model

- `Database` is the customer Resource and stable logical identity.
- `DatabaseClass` is a versioned customer-visible Resource describing an
  availability, durability, performance, capacity, support, and cost envelope.
- `Entitlement` decides which classes and limits a Principal may use.
- `DatabasePlacement` is restricted observed status owned by the Data plane; it
  is not customer intent and exposes no raw provider topology.
- create, resize, backup, restore, branch, promote, rotate, and delete are
  durable Operations.
- backups, exports, and restore evidence are Artifacts by digest.

## DatabaseClass contract

A class declares typed bounds and guarantees, including:

- intended workload class;
- availability target and failure-domain scope;
- durability, backup frequency, retention, RPO, and RTO;
- minimum/maximum compute, memory, storage, connections, and throughput;
- autoscaling and burst behavior;
- maintenance, upgrade, and support envelope;
- residency and isolation options when admitted;
- estimated and metered cost model; and
- capacity/admission behavior under scarcity.

A class name is stable. A material contract change creates a new class revision
or class; it is not silently changed behind an old name.

## Customer contract

Customers select a `DatabaseClass` reference and product settings. They do not
select:

- provider instance types;
- orchestration identities, internal volumes, placement classes, or operators;
- replication implementation;
- pool density;
- queue or scheduler names; or
- an internal database primary.

Marketing plans may recommend or entitle service classes, but plan names are not
accepted as database class aliases.

## Lifecycle

### Create

Creation accepts a canonical parent, Resource ID, typed database spec, class
reference, revision-safe request ID, and Policy context. It returns one
Operation. `Ready=true` is set only after the declared connection, durability,
security, and customer-path postconditions are observed.

A create that names no tier uses `starter` for managed Postgres
(`DEFAULT_MANAGED_DATABASE_TIER`, `crates/sylphx-bc-resources/src/database/tiers.rs`;
mirrored for SDK, manifest and console in `@sylphx/contract`). The create path
stores the tier on the resource, so the default applies to new creates only: a
resource created earlier keeps its stored tier (a stored `standard` still
resolves to `business`) and changes only through an explicit tier change.
The cache default is unchanged (`DEFAULT_CACHE_TIER`); it moves to
`starter` once cache tier change after create ships.

### Resize or class change

A class change is planned before execution and reports:

- compatibility and limit checks;
- expected interruption and maintenance class;
- estimated cost delta;
- capacity-admission result;
- data movement or placement consequences;
- rollback/compensation boundary; and
- required approval for destructive or irreversible transitions.

The logical Database name and `uid` remain stable unless the requested action
explicitly creates a new Database.

#### Current native tier change

`PATCH /v1/resources/{id}` with `{ "kind": "database", "tier": "<tier>" }`
(CLI: `sylphx db update <id> --tier <tier>`) changes the tier of an existing
managed Postgres. The write sets `tier`, bumps the resource generation, and
requeues the resource; the platform applies the new class as a rolling update
with the declared availability envelope preserved.

Policy:

- unknown tiers are refused; legacy aliases (`standard`, `performance`,
  `enterprise-1`, `enterprise-2`) map to their canonical ids;
- storage is never rewritten by a tier change (`storageGb` stays pinned per
  resource and never shrinks below the provisioned floor);
- a downgrade is refused when it could shrink storage, which is only possible
  when the resource has no pinned `storageGb` and the target tier default is
  smaller;
- an unchanged tier is a no-op (`200`, no generation bump); an applied change
  answers `202` with a `tierChange` receipt (`from`, `to`, `direction`,
  `generation`, target compute, rollout class).

### Backup, restore, and branch

- backup produces an immutable Artifact plus typed backup Resource state;
- restore creates a new Database by default;
- in-place restore is a distinct destructive Operation with plan and approval;
- branch creates a new isolated Database with explicit retention and data
  sensitivity;
- every action binds source revision, backup Artifact digest, target class,
  Policy decision, and Evidence.

### Delete

Deletion fences new bindings, applies retention/legal-hold Policy, proves
external deletion or retained state, emits terminal Events and Evidence, and
then tombstones or removes the Resource. “Force” is a separate Operation with
explicit data-loss and orphan semantics.

## Availability and scaling law

Database authorities are partitioned by Resource home and Cell. No global
primary, lock, storage quorum, or synchronous cross-Cell transaction sits in the
general management hot path. A physical technology may have its own local
quorum; that local mechanism never becomes the global Platform authority.

## Verification

Each shipped class requires current evidence for:

- availability and failover under declared failure scope;
- sustained and tail throughput at published limits;
- noisy-neighbor isolation and admission behavior;
- backup integrity, point-in-time recovery, restore, and disaster recovery;
- resize and class-change safety;
- encryption, credential rotation, tenant isolation, and audit;
- metering and invoice reconciliation;
- capacity and cost envelope; and
- real customer create, connect, write, failover, restore, and delete paths.

Legacy `hobby`, `starter`, `pro`, `business`, `enterprise`, size aliases,
`standard` aliases, and `/api/v1/resources` examples are predecessor vocabulary.
They may be mapped once by an executor during the hard cut, but they are not
preserved in the target contract.

## docs/reference/compute-profiles.md

# Compute Capacity Classes

**Status:** Derived target reference; exact commercial packaging and live capacity are discovered at runtime

A compute capacity class is a stable product-level execution envelope. It is not
a runner implementation, node type, scheduler queue, provider machine, or
billing plan.

For existing machine names, resource dimensions and invoice behavior, see
[machine capacity and billing semantics](machine-capacity-semantics.md). That
source audit is distinct from the target class contract below.

## Contract

Each class declares:

- stable class name and revision;
- CPU, memory, accelerator, architecture, operating-system, isolation, network,
  storage, and maximum-duration envelope;
- workload shapes for which it is eligible;
- expected startup and execution SLO;
- durability and workspace-retention behavior;
- concurrency, fairness, preemption, and overload policy;
- metering unit and cost-estimation inputs;
- admitted product regions and Cells;
- deprecation state and an explicit hard-cut successor when replaced.

The selected physical shape may vary by Cell while satisfying the same measured
contract. Unsupported or ambiguous requests fail typed; they never silently run
on a different class.

## Admission authorities

1. Entitlement (written by Kernel Billing) says which classes the customer purchased or may use.
2. Policy `LimitPolicy` says whether this Principal and request may consume the
   class, concurrency, budget, and effect scope.
3. Capacity admission says whether ready physical capacity exists.
4. The workload scheduler selects placement.

These decisions are correlated but never collapsed into one authority. A plan
or price name is not a scheduler label.

## Work integration

`Service`, `BatchJob`, `Workflow`, and `Session` reference a product capacity
class in typed intent. Plan resolves:

- class revision and compatibility with the workload Artifact;
- Entitlement and Policy revisions;
- admitted region/Cell availability;
- concurrency and queue impact;
- estimated cost and maximum bound;
- fallback behavior, which is normally `none` unless a caller explicitly plans
  an equivalent class set with a deterministic selection rule.

Apply returns an Operation. Admission wait, placement, startup, preemption,
execution, usage, cost, and terminal result remain observable without exposing
raw infrastructure.

## Lifecycle

A class replacement is an explicit contract revision or major hard cut.
Old labels, multi-label aliases, beta compatibility mappings are deleted; silent
size substitution is not retained. Discovery reports unavailable or retired classes
as typed state, and new intent uses the admitted successor identity.

Customer workflows and generated clients consume only names published by
current discovery. This reference intentionally contains no fixed plan-to-class
matrix and no claim that a historical label is currently available.

## Evidence

Each shipped class has measured:

- startup, queue, execution, and teardown latency;
- sustained throughput and tail latency under contention;
- tenant isolation and noisy-neighbor behavior;
- process, node, zone, scheduler, image, network, and storage failure behavior;
- overload, fairness, borrowing, and preemption behavior;
- metering accuracy and estimated-versus-actual cost;
- customer-path behavior for every supported workload and operating-system
  profile.

A label in source, a runner registered with a forge, or an idle machine is not
capacity proof. Exact availability comes from generated discovery, admitted
ready capacity, and trusted live readback.
