Content schemas
The field shapes a page type can be generated into — not page designs.
List libraries
Every library in the workspace with its schema count and the sites generating from it. Pass ?sitemap= to also learn which library that site currently uses.
query Parameters
sitemapHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List libraries › Responses
Success
Create a library
Creates a library to group content schemas. A library is a folder, not a namespace — schemas keep working wherever they are filed.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Create a library › Responses
Created
Delete a library
Soft delete. Sites pointing at the library are released first, so a deactivated library's schemas cannot stay in use through a stale pointer.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete a library › Responses
Success. No content.
Update a library
Renames or re-describes the library. The schemas it holds are untouched.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Update a library › Responses
Success
Fork a library
Copies a library and its schemas as an authored one, with no link back to the CMS it came from — so a later schema pull cannot overwrite the copy. This is how a site starts from a mirrored schema set and then diverges from it.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Fork a library › Responses
Success
List content schemas
A content schema is the field shape of a page type — not a page design. Scope with ?group= for one library, or ?sitemap= for the library that site generates from. With neither, every schema in the workspace is listed.
query Parameters
cursor^[A-Za-z0-9_-]+$grouplimitoffsetsitemapsort^-?[a-z0-9_]+$tpl_componenttpl_nametpl_nestableHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List content schemas › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Create a content schema
Defines the fields a page type can be generated into. It describes a shape, not a design — nothing here decides how a page looks.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Create a content schema › Request Body
tpl_nametpl_groupsitemaptpl_componenttpl_nestableCreate a content schema › Responses
Created
Get a content schema
Returns the schema with its component name and its field definitions.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get a content schema › Responses
Success
Delete a content schema
Removes the schema. Pages that were generated against it keep their content and their component name.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete a content schema › Responses
Success. No content.
Update a content schema
Changes the schema's fields. Pages already generated against it keep the content they have; only later generations see the new shape.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Update a content schema › Request Body optional
tpl_nametpl_componenttpl_nestableUpdate a content schema › Responses
Success
Import content schemas
Loads schema definitions in bulk, for moving a set between workspaces or seeding a new one.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Import content schemas › Request Body
datatpl_groupsitemapImport content schemas › Responses
Success
Get meta data defaults
The instructions the platform writes meta titles and meta descriptions with when a content schema sets none of its own, and the length limits every generated value is clamped to. A schema replaces either block through tpl_metadata.metaTitleInstructions / tpl_metadata.metaDescriptionInstructions.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get meta data defaults › Responses
Success
