Docs / Reference / read: brand design system changes

read: brand design system changes.

The brand and two versions, else the two newest to every value that differs, by path, with the basis on each side, and the counts

Figure 1POST /v1/read/brand_design_system_changesspecified

The caller sends BrandDesignSystemChangesInput to /v1/read/brand_design_system_changes. The platform returns a card whose body is BrandDesignSystemDiff.

POST/v1/read/brand_design_system_changes

What changed in a brand’s design system. 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 BrandDesignSystemChangesInput and returns a card whose body is BrandDesignSystemDiff.

Request body#

The request body is BrandDesignSystemChangesInput.

field	type	required
`brand`	`id`	yes
`from_version`	`count`	no
`to_version`	`count`	no

Response#

The route returns a card whose body is BrandDesignSystemDiff. 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 read grant. The platform or the desktop app serves this route.

Example#

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

Example

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

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

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

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

MCP tool#

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

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

{
  "brand": "…"
}

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

Claims#

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