read: simulation frame.

Reads the frame of one simulation to The answer gives the trajectory of every stock, the gain of every loop, the sensitivity to every intervention, and the set of options that compares strategies laid over the same template

Request body#

The request body is SimulationFrameInput.

Response#

The route returns a card whose body is MarketSimulationFrame. 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#

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 SimulationFrameInput allows. The build validates it against the schema of SimulationFrameInput.

curl -X POST https://api.scaleintelligence.co/v1/read/simulation_frame \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "simulation": "…" }'

import { client } from "@scale/sdk";
const answer = await client.read.simulation_frame({
    "simulation": "…"
  });
// answer.body is a MarketSimulationFrame. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/read/simulation_frame",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "simulation": "…"
    }).json()

let answer: Card = client.post("https://api.scaleintelligence.co/v1/read/simulation_frame")
    .header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
    .json(&SimulationFrameInput { /* the fields of the page */ }).send().await?.json().await?;

MCP tool#

The MCP tool si.read.simulation_frame 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/MarketSimulationFrame. The tool’s page describes it.

POST /v1/read/simulation_frame
Scale-Scope: …
Scale-As-True-On: …
Scale-As-Known-On: …
Scale-Key: …
content-type: application/json

{
  "simulation": "…"
}