Scale Intelligence■ Docs
Docs / Reference / act: map brand

act: map brand.

A web address, and the brand scope to hold the map to the map as it stands, with every part measured or never measured, and the demand raised

Figure 1POST /v1/act/map_brandspecified
CALLERyour app or an agentholds the keyAPI GATEWAY/v1/act/map_brand4 headersCORE: ACTrung brandgrant actRECORDreads or writesTASK, 202body MapThe input is MapBrandInput. Every response carries the contract's hash.flows forwardthe result
The caller sends MapBrandInput to /v1/act/map_brand. The platform returns a card whose body is Map.
POST/v1/act/map_branda task, 202

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

The route takes MapBrandInput and returns a card whose body is Map.

Request body#

The request body is MapBrandInput.

fieldtyperequirednote
websiteaddressyes
nametextno
tenantidyes

Response#

The route returns a card whose body is Map. 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. This route runs as a long step and returns a task with status 202. POST /v1/work/status returns the task’s progress, and POST /v1/work/cancel stops the task.

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 brand rung and a token with the act grant. The platform serves this route.

Example#

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

Example
curl -X POST https://api.scaleintelligence.co/v1/act/map_brand \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "website": "…", "tenant": "…" }'
import { client } from "@scale/sdk";
const answer = await client.act.map_brand({
    "website": "…",
    "tenant": "…"
  });
// answer.body is a Map. answer.foot holds the basis, the scope and the time.
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/act/map_brand",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "website": "…",
      "tenant": "…"
    }).json()
let answer: Card = client.post("https://api.scaleintelligence.co/v1/act/map_brand")
    .header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
    .json(&MapBrandInput { /* the fields of the page */ }).send().await?.json().await?;

MCP tool#

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

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

{
  "website": "…",
  "tenant": "…"
}
Without a key, this page shows the request only. The request body is MapBrandInput, and the route returns a card whose body is Map.

Claims#

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