read: value chain.
Reads the value chain of one vertical, with the brand whose participants are placed on it to The answer gives the chain's stocks and handovers with their counts, the participants on each stock, and the loops the templates name over it
Read the value chain. The call needs the brand rung under a token with the read grant, and it is served by either, by the size bound.
The route takes ValueChainInput and returns a card whose body is ValueChain.
Request body#
The request body is ValueChainInput.
| field | type | required | note |
|---|---|---|---|
vertical | id | yes | |
brand | id | no | |
segment | id | no |
Response#
The route returns a card whose body is ValueChain. 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 brand 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 ValueChainInput allows. The build validates it against the schema of ValueChainInput.
Example
curl -X POST https://api.scaleintelligence.co/v1/read/value_chain \
-H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
-H "content-type: application/json" \
-d '{ "vertical": "…" }'
import { client } from "@scale/sdk";
const answer = await client.read.value_chain({
"vertical": "…"
});
// answer.body is a ValueChain. answer.foot holds the basis, the scope and the time.
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/read/value_chain",
headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
json={
"vertical": "…"
}).json()
let answer: Card = client.post("https://api.scaleintelligence.co/v1/read/value_chain")
.header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
.json(&ValueChainInput { /* the fields of the page */ }).send().await?.json().await?;
MCP tool#
The MCP tool si.read.value_chain 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/ValueChain. The tool’s page describes it.
POST /v1/read/value_chain
Scale-Scope: …
Scale-As-True-On: …
Scale-As-Known-On: …
Scale-Key: …
content-type: application/json
{
"vertical": "…"
}Claims#
| claim | state | route or tool |
|---|---|---|
| The platform serves the route /v1/read/value_chain at contract 0476e35e6e275db5. | target | /v1/read/value_chain |