Semaphor

Domain Templates

Read and update the full definition of a semantic domain

Domain templates contain the full definition of a semantic domain: its datasets and their fields (identifiers, facts and dimensions), the relationships between datasets, its metrics, and context for agents.

Templates use schema version 2.1. GET always returns the 2.1 shape. PUT and PATCH accept 2.1 bodies, and still accept 2.0 bodies, which are upgraded on save; a body that mixes the two is refused with mixed_schema_versions. See the Template Guide for the format.

Recommended workflow: Read the current template, preview AI relationship suggestions (optional), save your changes, then commit to GitHub (optional). Save and commit are independent: a commit failure does not affect the saved template.

Endpoints

MethodEndpointDescription
GETGet templateRetrieve the full domain template
PUTSave templateSave changes to a domain template
PATCHPatch templatePartially update a domain template
POSTPreview discoveryPreview AI-suggested relationships between datasets
POSTCommit to GitHubCommit the template to a connected GitHub repository

On this page