Vivreal Documentation

Everything you need to set up, connect APIs, and launch with confidence.

What's in the docs

Guides for portal users, API reference for developers, and tutorials for everyone.

Create your account, set up your first group, navigate the dashboard, and understand the core workflow.

Create collections, define custom schemas, manage objects, upload media, and use version history.

Choose templates, deploy sites, configure custom domains, and manage site settings.

8 REST endpoints — fetch collections, products, site config, media, previews, and more. Full request/response docs.

Subscribe to real-time events: content published, site deployed, integration synced. Payload schemas and delivery details.

Build a product catalog, create a blog, deploy your first site, set up Stripe payments, automate with webhooks.

The docs site has a built-in AI assistant that can answer questions about Vivreal in real time.