Docs / Reference / act: capture

act: capture.

The document, the network events, the address, the person's identity to the capture with its source objects and the cells credited

Figure 1POST /v1/act/capturespecified

The caller sends CaptureInput to /v1/act/capture. The platform returns a card whose body is Capture.

POST/v1/act/capture

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

The route takes CaptureInput and returns a card whose body is Capture.

Request body#

The request body is CaptureInput.

field	type	required
`address`	`text`	yes
`document`	`text`	yes
`network_events`	`[json]`	yes
`identity`	`id`	no
`scope`	`one of this item \| this thread \| this channel as shown \| this page \| this meeting \| my outbound message`	yes
`under`	`one of say-so \| rule`	yes
`rule`	`id`	no
`extension_version`	`text`	yes
`artefact_hash`	`hash`	yes
`selection`	`text`	no

Response#

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

Example

curl -X POST https://api.scaleintelligence.co/v1/act/capture \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "address": "…", "document": "…", "network_events": [], "scope": "this item", "under": "say-so", "extension_version": "…", "artefact_hash": "…" }'

import { client } from "@scale/sdk";
const answer = await client.act.capture({
    "address": "…",
    "document": "…",
    "network_events": [],
    "scope": "this item",
    "under": "say-so",
    "extension_version": "…",
    "artefact_hash": "…"
  });
// answer.body is a Capture. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/act/capture",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "address": "…",
      "document": "…",
      "network_events": [],
      "scope": "this item",
      "under": "say-so",
      "extension_version": "…",
      "artefact_hash": "…"
    }).json()

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

MCP tool#

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

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

{
  "address": "…",
  "document": "…",
  "network_events": [],
  "scope": "this item",
  "under": "say-so",
  "extension_version": "…",
  "artefact_hash": "…"
}

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

Claims#

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