Getting Started
Create your workspace, connect your own PostgreSQL database, and build your first structured content model.
How can we help?
Search verified guides, troubleshoot issues, or explore topics across the SCHMA platform.
Search the Knowledge Base
Quickly find answers or browse guides below
Connecting your PostgreSQL database
How SCHMA connects to your self-hosted or cloud-hosted PostgreSQL 15+ database with the pgvector extension enabled, using standard connection strings, SSL, and isolated schema tables.
Getting StartedCreating your first content model
Design structured content schemas in the visual Schema Builder using SCHMA's 11 visual field types (backed by 14 core schema types), custom validation rules, and relational references.
Getting StartedUnderstanding drafts, publishing, and production isolation
How SCHMA isolates work-in-progress drafts from public delivery APIs, ensuring live applications only receive reviewed, published content.
Content ManagementSetting up live preview with your frontend
Configure real-time visual live preview between SCHMA Studio and your Next.js or React application using @schmadev/preview and secure postMessage events.
Content ManagementWorkspace roles and permissions
An overview of SCHMA's built-in membership roles—Owner, Admin, Editor, and Reviewer—and custom role permission boundaries across workspaces.
Teams & PermissionsUnderstanding Free vs Pro plan limits and quotas
A detailed comparison of SCHMA Free and Pro tiers, covering workspace seats (up to 2 on Free, up to 5 on Pro), media quotas (100 MB vs 1 GB), AI capabilities, and billing.
Plans & BillingCreating and managing API keys
How to generate Delivery and Management API keys, configure permission scopes, and authenticate HTTP and SDK requests.
Developer Guides & IntegrationsConfiguring the SCHMA MCP server
Connect AI editors like Cursor and Claude Desktop directly to your SCHMA workspace using @schmadev/mcp-server and the Model Context Protocol.
Developer Guides & IntegrationsTroubleshooting database connection problems
Actionable steps to diagnose and resolve PostgreSQL connection errors, SSL handshake failures, password escaping issues, and network timeouts in SCHMA.
TroubleshootingWhy published content is missing from your frontend
A systematic diagnostic guide to resolve missing content entries, draft status filtering, slug mismatches, tenant headers, and frontend cache layers.
TroubleshootingUsing version history and rolling back entries
How to view historical snapshots of entries in SCHMA Studio, inspect previous revisions, and safely restore earlier versions into working drafts.
Content ManagementScheduling entries and releases
How to schedule content entries for future publication, organize multi-document Release Bundles, and coordinate atomic campaign launches.
Content ManagementInviting team members and managing access
How to invite collaborators, manage pending access requests, update membership roles, and remove team members in SCHMA Studio.
Teams & PermissionsDelivery API quotas and rate limits
Understand SCHMA Delivery API monthly quotas, per-minute rate limits, response headers, and how edge caching optimizes request throughput.
Plans & BillingGetting started with the TypeScript SDK
How to install, configure, and query your SCHMA content using the official @schmadev/client TypeScript SDK with type-safe models, filtering, and pagination.
Developer Guides & IntegrationsSetting up webhooks and frontend revalidation
How to configure SCHMA webhooks, verify cryptographic HMAC SHA-256 signatures, and trigger on-demand ISR revalidation in Next.js when content changes.
Developer Guides & IntegrationsConfiguring BYOK AI providers
How to connect your own OpenAI, Anthropic, Google Gemini, or OpenRouter API keys to power the SCHMA AI Content Engine with custom model overrides.
Developer Guides & IntegrationsResolving API 401 and 403 errors
An actionable diagnostic guide to distinguish and fix HTTP 401 Unauthorized and 403 Forbidden responses, permission scopes, and token headers.
TroubleshootingCustom roles and workspace permissions
An overview of workspace membership roles, permission boundaries, content-type scoping, and the status of custom role capabilities in SCHMA.
Teams & PermissionsManaging media files and storage quotas
How to upload images and documents, organize assets in the Media Library, understand supported file types, and manage storage quotas.
Content ManagementSetting up SCHMA with Cursor via MCP
How to integrate Cursor IDE with your SCHMA workspace using the Model Context Protocol (@schmadev/mcp-server) for AI-driven schema inspection and content generation.
Developer Guides & IntegrationsSetting up SCHMA with Claude Desktop via MCP
How to connect Claude Desktop to your SCHMA workspace using the Model Context Protocol to query schemas, inspect content, and draft entries.
Developer Guides & IntegrationsProduction readiness checklist for SCHMA
A complete verification checklist covering database security, API key scopes, environment isolation, webhooks, and caching before launching a site powered by SCHMA.
Getting StartedAccount and security best practices
Practical security guidelines for protecting your SCHMA workspace, database credentials, API keys, webhook endpoints, and team access.
Account, Security & SupportDiagnostic: Resolve database connection problems
Instant checks for connection string syntax, database availability, and SSL settings.
TroubleshootingDiagnostic: Find missing published content
Instant checklist for publication state, content type slugs, API keys, and environments.
TroubleshootingDiagnostic: Fix API authorization errors (401/403)
Verify Bearer tokens, workspace slugs, and Delivery vs Management key permissions.
TroubleshootingDiagnostic: Understand AI assistant availability
Check your plan and BYOK AI provider settings when an assistant is unavailable.
TroubleshootingDiagnostic: Editor cannot connect through MCP
Verify Node.js, npx, API credentials, and workspace slug for Cursor or Claude Desktop.
TroubleshootingGenerate, review, and save AI drafts
Create staged previews, edit results, save selected drafts, and revisit generation runs.
SCHMA AIRead content with the JavaScript SDK
Connect a Next.js, Astro, or Node.js app using @schmadev/client.
IntegrationsTypeScript SDK client reference
Install and query published content using @schmadev/client with full TypeScript support.
SDKsCommand line interface (CLI)
Scaffold new projects with create-schma and generate TypeScript definitions with @schmadev/cli.
Developer ToolsModel Context Protocol (MCP) server reference
Configure Cursor, Claude Desktop, and AI coding assistants with the SCHMA MCP server.
Developer ToolsDelivery API requests and responses
REST endpoints, authentication headers, content type filters, and pagination.
ReferenceBrowse by Category
Explore guides, documentation, and answers organized by topic.
Content Management
Structure content models with 14 core field types, write in the visual editor, manage drafts, and run publishing operations.
Teams & Permissions
Manage workspace members, assign built-in roles, and control access across schemas, entries, and settings.
Plans & Billing
Understand Free (up to 2 members, including owner), Pro (£20/mo UK / €25/mo EU / $25/mo Rest of world), and Max (coming soon) tiers, media allowances, and API quotas.
Developer Guides & Integrations
Integrate using the JavaScript/TypeScript SDK, edge-cached REST and GraphQL delivery, or AI editor MCP tools.
Troubleshooting
Step-by-step diagnostic checks for database connections, published content, API auth errors, and AI setup.
Account, Security & Support
Learn about customer data ownership, tenant isolation, security posture, and contacting our technical team.
Quick Diagnostic and Support Links
Something isn’t working?
Follow structured checks for PostgreSQL connectivity, publication states, 401/403 API errors, and MCP setups.
System Status
Check live operational status for CMS Studio, Delivery APIs, Database Gateway, and global edge cache.
Contact Technical Support
Need direct assistance with an enterprise deployment, custom migration, or plan inquiry? Reach our team.