# docs

## Docs

- [Overview](https://synthetiq.com/docs/index.md): Explore different pathways for getting started on Synthetiq, from quickstarts to comprehensive guides on the foundations.
- [Administration UI](https://synthetiq.com/docs/platform-docs/app-framework/administration.md): Built-in admin interface for managing users, roles, organizations, identity providers, services, and OAuth clients
- [Add access control](https://synthetiq.com/docs/platform-docs/app-framework/creating/access-control.md): Define scopes, configure row-level security, and enforce permissions declaratively
- [Add an AI agent](https://synthetiq.com/docs/platform-docs/app-framework/creating/ai-agent.md): Configure the built-in AI agent with an LLM service and custom system prompt
- [Configure the app](https://synthetiq.com/docs/platform-docs/app-framework/creating/app-settings.md): App metadata and user-configurable settings
- [Add backend routes](https://synthetiq.com/docs/platform-docs/app-framework/creating/backend-procedures.md): Type-safe tRPC procedures with declarative access control and input validation
- [Add custom metrics](https://synthetiq.com/docs/platform-docs/app-framework/creating/custom-metrics.md): Track app-specific events and visualize them on the monitoring dashboard
- [Add a database schema](https://synthetiq.com/docs/platform-docs/app-framework/creating/database-schema.md): Define data models with Prisma and access data through the RLS-scoped database client
- [Add pages](https://synthetiq.com/docs/platform-docs/app-framework/creating/frontend-pages.md): React pages with client-side routing, authentication, and pre-built system pages
- [Getting started](https://synthetiq.com/docs/platform-docs/app-framework/creating/getting-started.md): Scaffold an app, understand the directory structure, and run the first build
- [Add a service integration](https://synthetiq.com/docs/platform-docs/app-framework/creating/service-integrations.md): Connect to external services with platform-managed credentials
- [Add a workflow](https://synthetiq.com/docs/platform-docs/app-framework/creating/workflows.md): Background job that sends a daily task summary via Slack
- [API Docs](https://synthetiq.com/docs/platform-docs/app-framework/docs/api.md): Auto-generated API reference with input/output schemas, scope requirements, and an interactive console
- [Data Docs](https://synthetiq.com/docs/platform-docs/app-framework/docs/data.md): Auto-generated database schema reference with tables, columns, relations, and access patterns
- [Docs overview](https://synthetiq.com/docs/platform-docs/app-framework/docs/docs-overview.md): Documentation pages auto-generated from your app's code and configuration
- [Pages Docs](https://synthetiq.com/docs/platform-docs/app-framework/docs/pages.md): Auto-generated page listing all app routes with titles, descriptions, and auth requirements
- [Services Docs](https://synthetiq.com/docs/platform-docs/app-framework/docs/services.md): Auto-generated service reference with operations, schemas, and cross-references
- [Visualize](https://synthetiq.com/docs/platform-docs/app-framework/docs/visualize.md): Interactive architecture diagram showing the full app structure with live page previews
- [Workflows Docs](https://synthetiq.com/docs/platform-docs/app-framework/docs/workflows-docs.md): Auto-generated workflow reference with schedules, step DAGs, and interactive visualizations
- [HTTP API](https://synthetiq.com/docs/platform-docs/app-framework/headless/http-api.md): Auto-generated HTTP endpoints from tRPC procedures
- [MCP](https://synthetiq.com/docs/platform-docs/app-framework/headless/mcp.md): Auto-generated MCP server exposing tRPC procedures as tools for AI clients
- [OAuth](https://synthetiq.com/docs/platform-docs/app-framework/headless/oauth.md): Built-in OAuth 2.0 provider for external application authentication
- [Headless API overview](https://synthetiq.com/docs/platform-docs/app-framework/headless/overview.md): HTTP endpoints, MCP server, and OAuth provider generated automatically from tRPC procedures
- [Deploying](https://synthetiq.com/docs/platform-docs/app-framework/lifecycle/deploying.md): Deploy apps to production with a single CLI command
- [Sharing](https://synthetiq.com/docs/platform-docs/app-framework/lifecycle/sharing.md): Share apps with users, organizations, and the org app store
- [Versioning](https://synthetiq.com/docs/platform-docs/app-framework/lifecycle/versioning.md): Create immutable version snapshots of your app for distribution and deployment
- [App Framework overview](https://synthetiq.com/docs/platform-docs/app-framework/overview.md): A full-stack framework for building applications with built-in authentication, access control, database, service integrations, and deployment
- [Access control reference](https://synthetiq.com/docs/platform-docs/app-framework/reference/access-control.md): scopes.json schema, scope naming, enforcement layers, and service access control
- [App config reference](https://synthetiq.com/docs/platform-docs/app-framework/reference/app-config.md): config.ts schema, setting types, and configuration files
- [Build validations reference](https://synthetiq.com/docs/platform-docs/app-framework/reference/build-validations.md): All build-time validators, blocked patterns, and generated artifacts
- [Database reference](https://synthetiq.com/docs/platform-docs/app-framework/reference/database.md): Prisma schema conventions, built-in models, multi-tenant support, and development vs. production databases
- [Metrics reference](https://synthetiq.com/docs/platform-docs/app-framework/reference/metrics.md): Structured logging, metrics.json schema, and monitoring dashboard configuration
- [Procedures reference](https://synthetiq.com/docs/platform-docs/app-framework/reference/procedures.md): tRPC procedure types, context object, metadata, streaming, and router structure
- [Routing reference](https://synthetiq.com/docs/platform-docs/app-framework/reference/routing.md): RouteConfig properties, system routes, navigation, and route protection
- [Row-level security reference](https://synthetiq.com/docs/platform-docs/app-framework/reference/row-level-security.md): RLS patterns, table configuration, and access evaluation order
- [Schedules reference](https://synthetiq.com/docs/platform-docs/app-framework/reference/schedules.md): schedules.json configuration for recurring workflow execution
- [Upgrading](https://synthetiq.com/docs/platform-docs/app-framework/upgrading.md): How to upgrade the App Framework and follow version migration guides
- [Agent commands](https://synthetiq.com/docs/platform-docs/cli/agent.md): Interact with the workspace agent from the command line
- [App commands](https://synthetiq.com/docs/platform-docs/cli/apps.md): Create, configure, package, and version Synthetiq apps
- [Deploy commands](https://synthetiq.com/docs/platform-docs/cli/deploy.md): Deploy apps and manage production deployments
- [CLI overview](https://synthetiq.com/docs/platform-docs/cli/overview.md): Install and use the Synthetiq CLI to manage workspaces, apps, services, and deployments
- [Provision commands](https://synthetiq.com/docs/platform-docs/cli/provision.md): Provision cloud infrastructure for Bring Your Own Infrastructure deployments
- [Runtime commands](https://synthetiq.com/docs/platform-docs/cli/runtime.md): Start local development servers for apps and services
- [Service commands](https://synthetiq.com/docs/platform-docs/cli/services.md): Create, build, configure, authenticate, and version Synthetiq services
- [Sharing commands](https://synthetiq.com/docs/platform-docs/cli/sharing.md): Share apps and services with users, manage store listings, and control publisher access
- [Store commands](https://synthetiq.com/docs/platform-docs/cli/store.md): Browse, search, and install apps and services from stores
- [Workspace commands](https://synthetiq.com/docs/platform-docs/cli/workspace.md): Initialize workspaces and manage authentication
- [Data boundary](https://synthetiq.com/docs/platform-docs/data-boundary.md): How Synthetiq separates platform metadata from your application data, source code, and service traffic
- [Identity providers](https://synthetiq.com/docs/platform-docs/deployments/administration/identity-providers.md): Configuring OIDC identity providers for app authentication
- [OAuth connections](https://synthetiq.com/docs/platform-docs/deployments/administration/oauth-connections.md): Managing OAuth applications for HTTP API and MCP access to deployed apps
- [Organization management](https://synthetiq.com/docs/platform-docs/deployments/administration/organization-management.md): Multi-tenant organization support with member management and data isolation
- [Service configuration](https://synthetiq.com/docs/platform-docs/deployments/administration/service-configuration.md): Configuring external service credentials and user connections in deployed apps
- [User management](https://synthetiq.com/docs/platform-docs/deployments/administration/user-management.md): Managing users, roles, scopes, and access control in deployed apps
- [Deploy role](https://synthetiq.com/docs/platform-docs/deployments/byoi/deploy-role.md): Cross-account trust model and deploy role permissions for BYOI deployments
- [Infrastructure](https://synthetiq.com/docs/platform-docs/deployments/byoi/infrastructure.md): Provisioning the Synthetiq deployment pipeline in your AWS account
- [BYOI Overview](https://synthetiq.com/docs/platform-docs/deployments/byoi/overview.md): One-click deployments on infrastructure you own and control
- [Resources created](https://synthetiq.com/docs/platform-docs/deployments/byoi/resources.md): AWS resources created by the Synthetiq infrastructure stacks
- [Security boundaries](https://synthetiq.com/docs/platform-docs/deployments/byoi/security.md): How apps are isolated in Bring Your Own Infrastructure deployments
- [Configuration](https://synthetiq.com/docs/platform-docs/deployments/configuration.md): Resource limits, scaling parameters, and workflow settings for deployed Synthetiq apps
- [Security boundaries](https://synthetiq.com/docs/platform-docs/deployments/hosted-security.md): How apps are isolated from each other in Synthetiq-hosted deployments
- [Hosted Overview](https://synthetiq.com/docs/platform-docs/deployments/hosted/overview.md): Fully managed one-click deployments on Synthetiq-hosted infrastructure
- [Overview](https://synthetiq.com/docs/platform-docs/deployments/monitoring.md): Built-in observability for deployed Synthetiq apps
- [Logs](https://synthetiq.com/docs/platform-docs/deployments/monitoring/logs.md): Structured logging and log search for deployed Synthetiq apps
- [Metrics](https://synthetiq.com/docs/platform-docs/deployments/monitoring/metrics.md): Application, infrastructure, and custom metrics for deployed Synthetiq apps
- [Observability API](https://synthetiq.com/docs/platform-docs/deployments/monitoring/observability-api.md): Programmatic access to metrics, logs, and workflow data for deployed Synthetiq apps
- [Workflows](https://synthetiq.com/docs/platform-docs/deployments/monitoring/workflows.md): Monitoring workflow executions and job health for deployed Synthetiq apps
- [Deployment overview](https://synthetiq.com/docs/platform-docs/deployments/overview.md): One-click deployment options for Synthetiq apps
- [Autoscaling](https://synthetiq.com/docs/platform-docs/deployments/scaling.md): How deployed apps auto-scale in response to traffic and workload demand
- [Supported platforms](https://synthetiq.com/docs/platform-docs/deployments/supported-platforms.md): Cloud platforms supported by Synthetiq Bring Your Own Infrastructure deployments
- [Synthetiq Desktop](https://synthetiq.com/docs/platform-docs/desktop/overview.md): The AI workspace for building, managing, and deploying apps and services through conversation
- [Overview](https://synthetiq.com/docs/platform-docs/index.md): Platform reference for Synthetiq
- [Next steps](https://synthetiq.com/docs/platform-docs/next-steps.md): Explore the platform's clients, frameworks, and infrastructure
- [API reference](https://synthetiq.com/docs/platform-docs/platform-api/api-reference.md): Complete list of Platform API routes with required authentication and scopes
- [Authentication](https://synthetiq.com/docs/platform-docs/platform-api/authentication.md): How users authenticate and how API routes are protected
- [Deployments](https://synthetiq.com/docs/platform-docs/platform-api/deployments.md): Trigger, monitor, and manage application deployments
- [Entities](https://synthetiq.com/docs/platform-docs/platform-api/entities.md): Manage apps, services, and chat extensions as publishable platform assets
- [Members & roles](https://synthetiq.com/docs/platform-docs/platform-api/members-and-roles.md): Manage organization members, roles, and permission scopes
- [Organizations](https://synthetiq.com/docs/platform-docs/platform-api/organizations.md): Manage organizations, storage configuration, and app stores
- [Platform API overview](https://synthetiq.com/docs/platform-docs/platform-api/overview.md): The metadata orchestration layer that manages organizations, entities, versioning, sharing, and deployment infrastructure
- [Production apps](https://synthetiq.com/docs/platform-docs/platform-api/production-apps.md): Manage production app lifecycle, subdomains, and OAuth credentials
- [Sharing](https://synthetiq.com/docs/platform-docs/platform-api/sharing.md): Share entities with users and manage publisher access
- [Versions](https://synthetiq.com/docs/platform-docs/platform-api/versions.md): Upload, download, and manage entity versions
- [Authentication](https://synthetiq.com/docs/platform-docs/services-framework/authentication.md): Auth type reference for OAuth2, custom credentials, and no-auth services
- [Configuration](https://synthetiq.com/docs/platform-docs/services-framework/configuration.md): Admin-level service settings reference
- [Data dictionary](https://synthetiq.com/docs/platform-docs/services-framework/data-dictionary.md): Bundle real-world data documentation with your service for AI agents and app integrations
- [Defining a service](https://synthetiq.com/docs/platform-docs/services-framework/defining-a-service.md): Create, configure, and build a service integration
- [Services Framework overview](https://synthetiq.com/docs/platform-docs/services-framework/overview.md): A framework for building external API integrations with platform-managed credentials and authentication
- [Tools](https://synthetiq.com/docs/platform-docs/services-framework/tools.md): Tool definition reference with schemas, streaming, and mutation flags
- [Using a service](https://synthetiq.com/docs/platform-docs/services-framework/using-a-service.md): Generate a typed client and call services from your app's backend
- [Synthetiq introduction](https://synthetiq.com/docs/platform-docs/synthetiq-introduction.md): How Synthetiq's end-to-end platform turns AI conversations into production applications
- [dataPath](https://synthetiq.com/docs/platform-docs/workflows-framework/data-path.md): Extract nested data from service responses
- [Defining workflows](https://synthetiq.com/docs/platform-docs/workflows-framework/defining-workflows.md): Workflow structure, the JobDefinition DSL, and how steps form a dependency graph
- [Error handling](https://synthetiq.com/docs/platform-docs/workflows-framework/error-handling.md): Retries, checkpointing, idempotency, and recovery strategies
- [Execution](https://synthetiq.com/docs/platform-docs/workflows-framework/execution.md): Worker service, job lifecycle, concurrency, and data storage
- [fieldMapping](https://synthetiq.com/docs/platform-docs/workflows-framework/field-mapping.md): Map and transform fields between source data and output columns
- [forEach](https://synthetiq.com/docs/platform-docs/workflows-framework/foreach.md): Iterate over rows from a previous step with parallelism and rate limiting
- [Workflows Framework overview](https://synthetiq.com/docs/platform-docs/workflows-framework/overview.md): Durable background workflows for async processing, scheduled jobs, multi-step pipelines, and data aggregation
- [Pagination](https://synthetiq.com/docs/platform-docs/workflows-framework/pagination.md): Automatic multi-page API fetching with cursor, page number, and offset strategies
- [Scheduling](https://synthetiq.com/docs/platform-docs/workflows-framework/scheduling.md): Cron-based recurring workflow execution
- [conditional](https://synthetiq.com/docs/platform-docs/workflows-framework/steps/conditional.md): Conditionally execute downstream steps based on data or variables
- [importFromDatabase](https://synthetiq.com/docs/platform-docs/workflows-framework/steps/import-from-db.md): Load data from your app's database into a workflow for processing
- [persistToDatabase](https://synthetiq.com/docs/platform-docs/workflows-framework/steps/persist-to-db.md): Write workflow results to your app's database
- [serviceCall](https://synthetiq.com/docs/platform-docs/workflows-framework/steps/service-call.md): Call an external service operation and store the results in an output table
- [sql](https://synthetiq.com/docs/platform-docs/workflows-framework/steps/sql.md): Transform data using DuckDB SQL queries
- [waitFor](https://synthetiq.com/docs/platform-docs/workflows-framework/steps/wait-for.md): Pause workflow execution for a duration or until a specific time
- [Variables](https://synthetiq.com/docs/platform-docs/workflows-framework/variables.md): Dynamic parameters resolved at workflow submission time
- [Your first app](https://synthetiq.com/docs/quickstart/app-writer.md): Build a working web application from a chat message — describe what you need, review the plan, and open the finished app.
- [Apps and Services](https://synthetiq.com/docs/quickstart/apps-and-services.md): A quick introduction to services and apps — the two building blocks you'll use in every Synthetiq workspace.
- [Download and login](https://synthetiq.com/docs/quickstart/download-and-login.md): Download the Synthetiq desktop app on your Mac and sign in to your account.
- [Discover and install apps](https://synthetiq.com/docs/quickstart/installing-apps.md): Find and install apps, services, and extensions from the Discover store
- [Your first service](https://synthetiq.com/docs/quickstart/service-writer.md): Connect Synthetiq to an external system from a chat message — describe the service you need, review the plan, and configure the connection.
- [Setup API keys](https://synthetiq.com/docs/quickstart/setup-and-api-key.md): Add your Claude API key and send your first message in Synthetiq.
- [Use an installed app](https://synthetiq.com/docs/quickstart/using-an-app.md): Open, interact with, and manage an app that's already installed in your Synthetiq workspace