read: model families.
Reads the model families that fit a vertical or a representation to Each family arrives with what it represents, the substrate it is written over, its solver and its check
Read the model families. The call needs the tenant rung under a token with the read grant, and it is served by either, by the size bound.
The route takes ModelFamiliesInput and returns a card whose body is ModelFamily.
Request body#
The request body is ModelFamiliesInput.
| field | type | required | note |
|---|---|---|---|
vertical | id | no | |
representation | one of stocks and flows | a graph of participants and handovers | a hypergraph of co-presence | agents with behaviours | a game of roles | no |
Response#
The route returns a card whose body is ModelFamily. Every card ends with a foot that states the basis of each number, the scope of the call, and the time when the facts were true.
Headers#
| header | required | meaning |
|---|---|---|
Scale-Scope | yes | the scope the call runs in: tenant/ |
Scale-As-True-On | no | the date the facts must have been true on; defaults to now |
Scale-As-Known-On | no | the date the facts must have been known on; defaults to now |
Scale-Key | no | for a change, the key made from the input; a repeat under the same key returns the unit held and writes nothing |
A caller needs the tenant rung and a token with the read grant. The platform or the desktop app serves this route.
Example#
The example sends the smallest body that ModelFamiliesInput allows. The build validates it against the schema of ModelFamiliesInput.
Example
curl -X POST https://api.scaleintelligence.co/v1/read/model_families \
-H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
-H "content-type: application/json" \
-d '{}'
import { client } from "@scale/sdk";
const answer = await client.read.model_families({});
// answer.body is a [ModelFamily]. answer.foot holds the basis, the scope and the time.
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/read/model_families",
headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
json={}).json()
let answer: Card = client.post("https://api.scaleintelligence.co/v1/read/model_families")
.header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
.json(&ModelFamiliesInput { /* the fields of the page */ }).send().await?.json().await?;
MCP tool#
The MCP tool si.read.model_families takes the same input and returns the same card. The tool only reads data. An MCP host that renders cards draws this card from ui://scale-intelligence/cards/ModelFamily. The tool’s page describes it.
POST /v1/read/model_families
Scale-Scope: …
Scale-As-True-On: …
Scale-As-Known-On: …
Scale-Key: …
content-type: application/json
{}Claims#
| claim | state | route or tool |
|---|---|---|
| The platform serves the route /v1/read/model_families at contract 0476e35e6e275db5. | target | /v1/read/model_families |