Docs / Reference / act: goal

act: goal.

A strategy, a measure, a target, a window to the goal, naming the measure's version

Figure 1POST /v1/act/goalspecified

The caller sends GoalInput to /v1/act/goal. The platform returns a card whose body is Goal.

POST/v1/act/goal

Add a goal. The call needs the strategy rung under a token with the act grant, and it is served by the platform.

The route takes GoalInput and returns a card whose body is Goal.

Request body#

The request body is GoalInput.

field	type	required	note
`goal`	Goal	yes

Response#

The route returns a card whose body is Goal. 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 strategy rung and a token with the act grant. The platform serves this route.

Example#

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

Example

curl -X POST https://api.scaleintelligence.co/v1/act/goal \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "goal": { "strategy": "…", "measure": "…", "measure_version": 0, "target": null, "window": "…" } }'

import { client } from "@scale/sdk";
const answer = await client.act.goal({
    "goal": {
      "strategy": "…",
      "measure": "…",
      "measure_version": 0,
      "target": null,
      "window": "…"
    }
  });
// answer.body is a Goal. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/act/goal",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "goal": {
        "strategy": "…",
        "measure": "…",
        "measure_version": 0,
        "target": null,
        "window": "…"
      }
    }).json()

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

MCP tool#

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

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

{
  "goal": {
    "strategy": "…",
    "measure": "…",
    "measure_version": 0,
    "target": null,
    "window": "…"
  }
}

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

Claims#

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