get_metamodel
readSince v1.0Get the model's schema (metamodel). Returns all node types, relationship types, their properties, allowed connections, and instance counts. Always call this first to understand what the model contains. For simulation models it also reports each property's computed flag and Rhai formula and each node type's act_script, plus a self-describing "scripting" block documenting the available simulation functions (get_connected, sum_prop, agent.get_prop/set_prop, …) so you can author formulas correctly.
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
locale | String | — | [get_metamodel] Optional locale code (e.g. 'de', 'en') to return translated names and descriptions. Defaults to model's default language. |
Example Request
{"locale": "en"}Example Response
{"model_name": "Product Roadmap", "node_types": [{"name": "Feature", "instance_count": 47, "properties": [{"name": "status", "data_type": "String"}]}], "total_nodes": 59}