> ## Documentation Index
> Fetch the complete documentation index at: https://synthetiq.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Platform API overview

> The metadata orchestration layer that manages organizations, entities, versioning, sharing, and deployment infrastructure

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

| Area                                                                           | Description                                                |
| ------------------------------------------------------------------------------ | ---------------------------------------------------------- |
| [Authentication](/docs/platform-docs/platform-api/authentication)                   | User sessions, deploy API keys, NPM tokens                 |
| [Organizations](/docs/platform-docs/platform-api/organizations)                     | Multi-tenant workspaces, storage configuration, app stores |
| [Members & Roles](/docs/platform-docs/platform-api/members-and-roles)               | User management, role-based access control, scopes         |
| [Service accounts & OIDC trusts](/docs/platform-docs/platform-api/service-accounts) | Machine identities and credential-free CI authentication   |
| [Entities](/docs/platform-docs/platform-api/entities)                               | Apps, services, and chat extensions as publishable assets  |
| [Versions](/docs/platform-docs/platform-api/versions)                               | Version upload, download, and active version management    |
| [Sharing](/docs/platform-docs/platform-api/sharing)                                 | Direct user sharing and publisher management               |
| [Production Apps](/docs/platform-docs/platform-api/production-apps)                 | Production app lifecycle, subdomains, OAuth credentials    |
| [Deployments](/docs/platform-docs/platform-api/deployments)                         | Deployment trigger, status tracking, phases, and logs      |
| [Deployment infrastructure (BYOI)](/docs/platform-docs/platform-api/aws-config)     | AWS deployment targets for Bring Your Own Infrastructure   |

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

## How clients interact with the platform

```mermaid theme={null}
graph LR
    Desktop[Synthetiq Desktop] --> API[Platform API]
    CLI[Synthetiq CLI] --> API
    API --> Orgs[Organizations]
    API --> Users[Users & Roles]
    API --> Entities[Entities & Versions]
    API --> Shares[Sharing & Stores]
    API --> Deploys[Deployments]
```

## Authentication overview

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

See [Authentication](/docs/platform-docs/platform-api/authentication) for details.

## Authorization model

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