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

https://api.synthetiq.com

​
Resource areas

AreaDescription
AuthenticationUser sessions, deploy API keys, NPM tokens
OrganizationsMulti-tenant workspaces, storage configuration, app stores
Members & RolesUser management, role-based access control, scopes
EntitiesApps, services, and chat extensions as publishable assets
VersionsVersion upload, download, and active version management
SharingDirect user sharing and publisher management
Production AppsProduction app lifecycle, subdomains, OAuth credentials
DeploymentsDeployment trigger, status tracking, phases, and logs

​
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.