Guides
Models
A model is the top-level container for your schema. It holds entity types, relationships, and all their properties.
Create a model
From the dashboard, click New model. Fill in a name and optional description. You can also start from a template (see below).
Rename or edit description
Open the model in the workbench. Click the model name in the toolbar to rename it inline. The description can be edited from the model's settings panel.
Templates
Templates give you a pre-populated schema to start from. When creating a model, click Start from template and choose from the available options:
- E-Commerce — Products, Orders, Customers, Categories
- Knowledge Graph — Entities, concepts, and semantic relationships
- Social Network — Users, Posts, Connections, Groups
- CMS — Content types, Authors, Tags, Media
- Logistics — Shipments, Warehouses, Carriers, Routes
- Healthcare — Patients, Providers, Encounters, Diagnoses
- Financial Services — Accounts, Transactions, Instruments, Portfolios
- Real Estate — Properties, Listings, Agents, Transactions
Duplicate a model
From the dashboard, open a model's context menu (right-click or the ⋯ button) and choose Duplicate. This creates a full copy of the model — including all entity types, relationships, and properties — with "Copy of" prepended to the name.
Publish and draft
All edits auto-save to a draft. The draft is your working copy — only you and your collaborators can see it.
When you're ready for consumers to see the changes, click Publish in the workbench toolbar. This creates a versioned snapshot. The API and share links always serve the published snapshot, never the draft.
Unpublishing a model removes it from the API and share link (existing URLs return 404 until re-published).
Archive a model
Archived models are hidden from your dashboard by default but remain accessible. To archive, open the model's context menu on the dashboard and choose Archive.
To view archived models, toggle Show archived on the dashboard. To restore an archived model, open its context menu and choose Unarchive.
Archived models are excluded from the public API unless explicitly unarchived.
Delete a model
Deletion is permanent. Open the model's context menu and choose Delete. You'll be asked to confirm by typing the model name.