Skip to main content
The Synthetiq Platform API is the orchestration layer that powers the CLI and Desktop app. It manages everything around the code — organizations, users, entity lifecycle, versioning, sharing, stores, deployment infrastructure, and database provisioning. When you push a version, share an app, trigger a deployment, or install from the org store, the client is calling the Platform API.

​
Base URL

​
Resource areas

The API is REST over HTTPS; for TypeScript/Node, the typed Node SDK (@synthetiq/platform-sdk) wraps every resource below.

​
How clients interact with the platform

​
Authentication overview

Users authenticate through the CLI or Desktop app. The platform manages sessions and permissions automatically. See Authentication for details.

​
Authorization model

Access control is managed at the organization level. Users are assigned roles that grant specific API permissions via RBAC.