Docs / Reference / act: watch site

act: watch site.

A `WatchSiteInput` to the watch, ready or not ready; for a preview, the pages it would read and the changes it would have raised over the window

Figure 1POST /v1/act/watch_sitespecified

The caller sends WatchSiteInput to /v1/act/watch_site. The platform returns a card whose body is SiteWatch.

POST/v1/act/watch_site

Watch a site. The call needs the brand rung under a token with the act grant, and it is served by the platform.

The route takes WatchSiteInput and returns a card whose body is SiteWatch.

Request body#

The request body is WatchSiteInput.

field	type	required	note
`watch`	SiteWatch	yes
`flow`	`one of write \| preview \| arm \| disarm`	yes

Response#

The route returns a card whose body is SiteWatch. 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/, then /brand/, then /strategy/
`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 act grant. The platform serves this route.

Example#

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

Example

curl -X POST https://api.scaleintelligence.co/v1/act/watch_site \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "watch": { "site": "…", "page_patterns": [], "use_sitemap": false, "cadence": "…", "conditions": { "tree": { "form": "group" }, "population": "…", "tree_hash": "…", "register_hash": "…", "compiler_version": "…", "comparator_versions": {} }, "channels": [], "state": { "ready": false, "since": "…" } }, "flow": "write" }'

import { client } from "@scale/sdk";
const answer = await client.act.watch_site({
    "watch": {
      "site": "…",
      "page_patterns": [],
      "use_sitemap": false,
      "cadence": "…",
      "conditions": {
        "tree": {
          "form": "group"
        },
        "population": "…",
        "tree_hash": "…",
        "register_hash": "…",
        "compiler_version": "…",
        "comparator_versions": {}
      },
      "channels": [],
      "state": {
        "ready": false,
        "since": "…"
      }
    },
    "flow": "write"
  });
// answer.body is a SiteWatch. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/act/watch_site",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "watch": {
        "site": "…",
        "page_patterns": [],
        "use_sitemap": false,
        "cadence": "…",
        "conditions": {
          "tree": {
            "form": "group"
          },
          "population": "…",
          "tree_hash": "…",
          "register_hash": "…",
          "compiler_version": "…",
          "comparator_versions": {}
        },
        "channels": [],
        "state": {
          "ready": false,
          "since": "…"
        }
      },
      "flow": "write"
    }).json()

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

MCP tool#

The MCP tool si.act.watch_site 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/SiteWatch. The tool’s page describes it.

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

{
  "watch": {
    "site": "…",
    "page_patterns": [],
    "use_sitemap": false,
    "cadence": "…",
    "conditions": {
      "tree": {
        "form": "group"
      },
      "population": "…",
      "tree_hash": "…",
      "register_hash": "…",
      "compiler_version": "…",
      "comparator_versions": {}
    },
    "channels": [],
    "state": {
      "ready": false,
      "since": "…"
    }
  },
  "flow": "write"
}

Without a key, this page shows the request only. The request body is WatchSiteInput, and the route returns a card whose body is SiteWatch.

Claims#

claim	state	route or tool
The platform serves the route /v1/act/watch_site at contract 0476e35e6e275db5.	target	`/v1/act/watch_site`