Docs / Reference / act: capture rule

act: capture rule.

The rule to the rule, ready or not ready with the reason

Figure 1POST /v1/act/capture_rulespecified

The caller sends CaptureRuleInput to /v1/act/capture_rule. The platform returns a card whose body is CaptureRule.

POST/v1/act/capture_rule

Write a capture rule. The call needs the user rung under a token with the act grant, and it is served by the platform.

The route takes CaptureRuleInput and returns a card whose body is CaptureRule.

Request body#

The request body is CaptureRuleInput.

field	type	required	note
`platform`	`text`	yes
`mode`	`one of on my say-so \| on my own submit \| ask me on this platform \| every page I open \| never`	yes
`way`	AccessMethod	no
`default_scope`	`one of this item \| this thread \| this channel as shown \| this page \| this meeting \| my outbound message`	yes
`never_captured`	`[text]`	yes	addresses or kinds
`redactions`	RedactionRule	no	the person’s own
`browser_grant`	`one of given \| not given \| not needed`	no	the browser’s standing host permission for the platform as the extension found it when the rule was written: asked of the person for every page I open, and not needed for the other modes; absent when the rule is written from a surface that is not the browser

Response#

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

Example#

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

Example

curl -X POST https://api.scaleintelligence.co/v1/act/capture_rule \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "platform": "…", "mode": "on my say-so", "default_scope": "this item", "never_captured": [] }'

import { client } from "@scale/sdk";
const answer = await client.act.capture_rule({
    "platform": "…",
    "mode": "on my say-so",
    "default_scope": "this item",
    "never_captured": []
  });
// answer.body is a CaptureRule. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/act/capture_rule",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "platform": "…",
      "mode": "on my say-so",
      "default_scope": "this item",
      "never_captured": []
    }).json()

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

MCP tool#

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

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

{
  "platform": "…",
  "mode": "on my say-so",
  "default_scope": "this item",
  "never_captured": []
}

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

Claims#

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