Menu
Platform
AI
Alerts and status pages
App store purchases
Credits
Generated Assets
Knowledge
KV
Localization
Notifications
Organizations
Payments
Queues
Realtime
Sandboxes
Storage
Workflows
API reference
- Overview
- Access API keys
- Agent sessions API
- Agent versions API
- Agents API
- AI models API
- Artifact references API
- Artifacts API
- Assets API
- Auth configs API
- Bank receipts API
- Bank transfer accounts API
- Buckets API
- Builds API
- Catalogs API
- Chat profiles API
- Chat reports API
- Chat sticker packs API
- Checkout policies API
- Checkout sessions API
- Config changes API
- Config flags API
- Config segments API
- Connection providers API
- Connections API
- Connectors API
- Credit grants API
- Customer organizations API
- Customer subscriptions API
- Databases API
- Documents API
- Email domains API
- End users API
- Entities API
- Entitlement grants API
- Entries API
- Environments API
- Episodes API
- Error events API
- Error groups API
- Events API
- Exchange rates API
- Generations API
- Glossaries API
- Goals API
- Identities API
- Inbound emails API
- Inbound endpoints API
- Inbound messages API
- Inbound sms API
- Invitations API
- Job runs API
- Jobs API
- Knowledge schemas API
- KV API
- KV namespaces API
- Lease events API
- Leases API
- Licence keys API
- Licence tokens API
- Mail domains API
- Mail routes API
- Mailbox connect links API
- Mailbox OAUTH apps API
- Mailboxes API
- Memberships API
- Memories API
- Memory stores API
- Merchant accounts API
- Message topics API
- Messages API
- OAUTH clients API
- Objects API
- Organization roles API
- Orgs API
- Owner pools API
- Phone numbers API
- Portal sessions API
- Preferences API
- Price catalogs API
- Processor events API
- Projects API
- Queued executions API
- Queues API
- Realtime channels API
- Realtime members API
- Realtime messages API
- Recipients API
- Relations API
- Releases API
- Revenue API
- Revenue facts API
- Revenue sources API
- Runs API
- Sandbox shapes API
- Schedules API
- Scrubbing policies API
- Search API
- Search indexes API
- Secret versions API
- Secrets API
- Service enablements API
- Service observations API
- Services API
- Serving routes API
- Session events API
- Sessions API
- Signing key versions
- Signing keys
- Sms numbers API
- Source maps API
- Spaces API
- Store connections API
- Store purchases API
- Subscriptions API
- Suppressions API
- Tax threshold statuses API
- Templates API
- Test clocks API
- Token exchanges API
- Transfers API
- Trust policies API
- Trusted issuers API
- Uptime checks API
- Uptime manifests API
- Uptime sources API
- Usage events API
- Usage invoices API
- Usage meter prices API
- Usage meters API
- Usage reservations API
- Usage settings API
- Usage tiers API
- Volumes API
- Waits API
- Webhook deliveries API
- Webhook endpoints API
- Workflows API
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Compute & delivery2 min
Installation
Install the Sylphx CLI, sign in, and send your first request.
- Binary
- sylphx
- Channels
- curl · npm · pnpm · bun
- Package
- @sylphx/cli
Before you start
- A terminal on macOS or Linux (the CLI is a native Rust binary)
- A Sylphx account
- One install channel — the upgrade path follows the channel you pick
One CLI for the platform
The CLI calls the same API as the SDKs for Access, Data, Auth, AI and other services. Run
sylphx --help to see the commands your installed version supports.Install the Sylphx CLI
Pick one channel. Same sylphx binary everywhere:
typescript
curl -fsSL https://sylphx.com/install/cli | bash
export PATH="$HOME/.local/bin:$PATH"
sylphx --versiontypescript
npm install -g @sylphx/cli
sylphx --versiontypescript
pnpm add -g @sylphx/cli
sylphx --versiontypescript
bun add -g @sylphx/cli
sylphx --versionAfter install
bash
sylphx --version
sylphx login
sylphx access whoamiQuickstart walkthrough: Sign in, create a project, deploy.
Verify
sylphx --version reports the installed version. After sign-in,sylphx access whoami returns the caller and the key’s scopes.Independent products
Identity, Data, Commerce, Events, Observability, Compute, and AI are not Cloud SKUs. Their docs and credentials live on those product sites. Do not treat leftover
@sylphx/apps entry points as the Cloud deploy path.