Docs / Reference / act: workflow

act: workflow.

Its steps and what starts it to the workflow, and for a preview what it would have done over history, acting on nothing

Figure 1POST /v1/act/workflowspecified

The caller sends WorkflowInput to /v1/act/workflow. The platform returns a card whose body is WorkflowAnswer.

POST/v1/act/workflow

Write, preview and arm a workflow. The call needs the strategy rung under a token with the act grant, and it is served by the platform.

The route takes WorkflowInput and returns a card whose body is WorkflowAnswer.

Request body#

The request body is WorkflowInput.

field	type	required	note
`workflow`	Workflow	yes
`do`	`one of write \| preview \| arm`	yes

Response#

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

Example

curl -X POST https://api.scaleintelligence.co/v1/act/workflow \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "workflow": { "name": "…", "starts_on": "a match", "steps": [], "strategy": "…", "state": { "ready": false, "since": "…" } }, "do": "write" }'

import { client } from "@scale/sdk";
const answer = await client.act.workflow({
    "workflow": {
      "name": "…",
      "starts_on": "a match",
      "steps": [],
      "strategy": "…",
      "state": {
        "ready": false,
        "since": "…"
      }
    },
    "do": "write"
  });
// answer.body is a WorkflowAnswer. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/act/workflow",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "workflow": {
        "name": "…",
        "starts_on": "a match",
        "steps": [],
        "strategy": "…",
        "state": {
          "ready": false,
          "since": "…"
        }
      },
      "do": "write"
    }).json()

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

MCP tool#

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

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

{
  "workflow": {
    "name": "…",
    "starts_on": "a match",
    "steps": [],
    "strategy": "…",
    "state": {
      "ready": false,
      "since": "…"
    }
  },
  "do": "write"
}

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

Claims#

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