Docs / Reference / act: correct

act: correct.

The id of the wrong event, and the right facts to a correcting event

Figure 1POST /v1/act/correctspecified

The caller sends CorrectInput to /v1/act/correct. The platform returns a card whose body is Event.

POST/v1/act/correct

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

The route takes CorrectInput and returns a card whose body is Event.

Request body#

The request body is CorrectInput.

field	type	required
`event`	`id`	yes
`correction`	Event	yes
`why`	`text`	yes

Response#

The route returns a card whose body is Event. 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 CorrectInput allows. The build validates it against the schema of CorrectInput.

Example

curl -X POST https://api.scaleintelligence.co/v1/act/correct \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "event": "…", "correction": { "flow": "…", "unit": "…", "at": "…", "by": { "kind": "a user", "came_in_through": "a session", "access_scopes": [], "tenant": "…", "grants": [] }, "plane": "tenant plane", "outcome": "…", "run": "…" }, "why": "…" }'

import { client } from "@scale/sdk";
const answer = await client.act.correct({
    "event": "…",
    "correction": {
      "flow": "…",
      "unit": "…",
      "at": "…",
      "by": {
        "kind": "a user",
        "came_in_through": "a session",
        "access_scopes": [],
        "tenant": "…",
        "grants": []
      },
      "plane": "tenant plane",
      "outcome": "…",
      "run": "…"
    },
    "why": "…"
  });
// answer.body is a Event. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/act/correct",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "event": "…",
      "correction": {
        "flow": "…",
        "unit": "…",
        "at": "…",
        "by": {
          "kind": "a user",
          "came_in_through": "a session",
          "access_scopes": [],
          "tenant": "…",
          "grants": []
        },
        "plane": "tenant plane",
        "outcome": "…",
        "run": "…"
      },
      "why": "…"
    }).json()

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

MCP tool#

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

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

{
  "event": "…",
  "correction": {
    "flow": "…",
    "unit": "…",
    "at": "…",
    "by": {
      "kind": "a user",
      "came_in_through": "a session",
      "access_scopes": [],
      "tenant": "…",
      "grants": []
    },
    "plane": "tenant plane",
    "outcome": "…",
    "run": "…"
  },
  "why": "…"
}

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

Claims#

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