Browse the documentation

REST API

Templates

List and read the Layerz templates you have access to, official or from your workspace library, and start a new model from one over the REST API.

A template is a read-only copy of a model, published from the app: official (curated by Layerz) or workspace (your workspace's library).

Method and pathDoes
GET /templatesThe templates you can read; ?scope=official or ?scope=workspace
GET /templates/:idOne template, with its blueprint

Each template carries a description, its FINANCE.md, which is its usage guide, and a summary of its structure.

To start a model from a template, POST /models with template_id: the new model copies its structure, values, sources and mapping rules (connector credentials excluded), and the template stays unchanged. Publishing a template happens in the app.