Ligantic
Knowledge Base
Tutorials
Updates
Search Articles
Login
Free Sign Up
Home
Get Started
Tutorials
How-to guides
Reference
Explanation
Spaces
Schemas
Flows
Experiences
Endpoints
SDK and CLI
Browse documentation
Home
Get Started
Spaces
Schemas
Flows
Experiences
Endpoints
SDK and CLI
Docs
/

How to Create a Schema

This guide shows you how to create a Schema in Studio.

Prerequisites

  • The ADMIN role in the Space.

Steps

  1. Open Space Settings → Schemas.
  2. Click Create Schema.
  3. You are taken directly to the Schema editor with a blank object Schema.
  4. Complete the Schema details:

    • Name
    • Display Template — how Records are labelled, with field names in braces, for example {First Name} {Last Name}. Defaults to {id}.
    • Auto-save (optional)
  5. Configure the fields in the Schema editor. For each field type's options, see Schema Field Types Reference.
  6. Optional: click Generate or import schema to open the inline import panel.
  7. Click Create Schema.

Import Formats

The import panel supports:

  • JSON Schema
  • Sample JSON value
  • CSV data
  • XLSX file
  • Ligantic Schema JSON
  • AI generation mode (when enabled)

After import, review and adjust the inferred Schema before saving.

The import panel is shown inline during Schema creation (not as a modal). Use Generate or import schema in the editor header to open the import panel and switch to AI generation mode. Existing Schema editing still supports direct schema import inside the editor.

AI Generation Mode

  • AI-assisted Schema generation is metered and consumes Ligantic credits per run.
  • AI generation mode includes example tags (for Experience-oriented Schema ideas) that can be clicked to prefill the Schema description prompt.
  • AI-generated Schema output can prefill Name (from Schema title, singularized) and Display Template (from x-ligantic-display-template) when provided.

Edit the Display Template

  • When creating or editing a Schema, edit the Display Template with the template editor: insert id or a field as a variable. Nested object fields are saved as the parent's display name followed by the nested field key, for example {Address.city}. Hand-written paths such as {Address.City} or {address.city} also resolve to the nested value. An AI-generated suggestion replaces the current template.
  • Sorting a Schema's table by its ID column orders the Records by their display name: by each field the template references, in template order. For {Last Name}, {First Name}, Records sort by Last Name, then by First Name.

Related pages

Schema Field Types Reference
This reference documents all available field types for defining Schemas in Ligantic. Schemas define the structure of your data and are the foundation for both Experiences and Flows.
Page not found. It may have moved or may not be published.
Browse documentation