Scale Intelligence■ Docs
Docs / Reference / act: keep monitor

act: keep monitor.

Its name, its predicate, the place it runs at, the kind of signal it makes, the strategy where one is chosen, and for a platform monitor the vertical to the monitor with its version, not armed; not ready while its predicate does not compile at its place, with the reasons from compile

Figure 1POST /v1/act/keep_monitorspecified
CALLERyour app or an agentholds the keyAPI GATEWAY/v1/act/keep_monitor4 headersCORE: ACTrung strategygrant actRECORDreads or writesCARD, 200body MonitorThe input is KeepMonitorInput. Every response carries the contract's hash.flows forwardthe result
The caller sends KeepMonitorInput to /v1/act/keep_monitor. The platform returns a card whose body is Monitor.
POST/v1/act/keep_monitor

Keep a monitor. The call needs the strategy rung under a token with the act grant, and it is served by either, by the size bound.

The route takes KeepMonitorInput and returns a card whose body is Monitor.

Request body#

The request body is KeepMonitorInput.

fieldtyperequirednote
nametextyes
predicatePredicateyesthe tree, compiled at the place
placePlaceARunsAtyes
kind_of_signalKindOfSignalyes
strategyidnothe brand’s standing strategy unless one is chosen
verticaltextnofor a platform monitor

Response#

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

headerrequiredmeaning
Scale-Scopeyesthe scope the call runs in: tenant/, then /brand/, then /strategy/
Scale-As-True-Onnothe date the facts must have been true on; defaults to now
Scale-As-Known-Onnothe date the facts must have been known on; defaults to now
Scale-Keynofor 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 strategy rung and a token with the act grant. The platform or the desktop app serves this route.

Example#

The example sends the smallest body that KeepMonitorInput allows. The build validates it against the schema of KeepMonitorInput.

Example
curl -X POST https://api.scaleintelligence.co/v1/act/keep_monitor \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "name": "…", "predicate": { "tree": { "form": "group" }, "population": "…", "tree_hash": "…", "register_hash": "…", "compiler_version": "…", "comparator_versions": {} }, "place": "…", "kind_of_signal": "…" }'
import { client } from "@scale/sdk";
const answer = await client.act.keep_monitor({
    "name": "…",
    "predicate": {
      "tree": {
        "form": "group"
      },
      "population": "…",
      "tree_hash": "…",
      "register_hash": "…",
      "compiler_version": "…",
      "comparator_versions": {}
    },
    "place": "…",
    "kind_of_signal": "…"
  });
// answer.body is a Monitor. answer.foot holds the basis, the scope and the time.
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/act/keep_monitor",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "name": "…",
      "predicate": {
        "tree": {
          "form": "group"
        },
        "population": "…",
        "tree_hash": "…",
        "register_hash": "…",
        "compiler_version": "…",
        "comparator_versions": {}
      },
      "place": "…",
      "kind_of_signal": "…"
    }).json()
let answer: Card = client.post("https://api.scaleintelligence.co/v1/act/keep_monitor")
    .header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
    .json(&KeepMonitorInput { /* the fields of the page */ }).send().await?.json().await?;

MCP tool#

The MCP tool si.act.keep_monitor takes the same input and returns the same card. The tool changes data and needs a grant. An MCP host that renders cards draws this card from ui://scale-intelligence/cards/Monitor. The tool’s page describes it.

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

{
  "name": "…",
  "predicate": {
    "tree": {
      "form": "group"
    },
    "population": "…",
    "tree_hash": "…",
    "register_hash": "…",
    "compiler_version": "…",
    "comparator_versions": {}
  },
  "place": "…",
  "kind_of_signal": "…"
}
Without a key, this page shows the request only. The request body is KeepMonitorInput, and the route returns a card whose body is Monitor.

Claims#

claimstateroute or tool
The platform serves the route /v1/act/keep_monitor at contract 0476e35e6e275db5.target/v1/act/keep_monitor