Get control model (structure + node types)
singular_get_modelRetrieve the structural model of an app to discover sub-compositions and control nodes, ensuring correct node IDs are used before writing content.
Instructions
Get the structural model of an app: every sub-composition and its control nodes with id, title, type (lowercase: text, textarea, number, image, color, checkbox, audio, json, timecontrol, button), default/reset values, and index. This is the schema-discovery call to run BEFORE writing content — payload keys must be control-node ids from here.
Args: app/appToken; sub_composition (optional name/id filter); response_format. Returns { subCompositions: [{ id, name, state, nodeCount, nodes: [{ id, title, type, index, defaultValue, resetValue }] }] }.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| app | No | Alias of a registered app instance (see register_app / list_apps). Preferred over a raw token. | |
| appToken | No | Raw Singular control-app token for a one-off/unregistered instance. If both 'app' and 'appToken' are given, 'appToken' wins. | |
| response_format | No | Output format: 'markdown' (human-readable) or 'json' (machine-readable). Default 'markdown'. | markdown |
| sub_composition | No | Optional: only include the sub-composition whose name or id matches this. |