Docs / Reference / act: scrape template

act: scrape template.

A `TemplateInput` to the template, ready or not ready with the reason; for a preview, the rows from its samples and a bounded live scope

Figure 1POST /v1/act/scrape_templatespecified

The caller sends TemplateInput to /v1/act/scrape_template. The platform returns a card whose body is ExtractionTemplate.

POST/v1/act/scrape_template

Write, preview, arm or retire a scrape template. The call needs the brand rung under a token with the act grant, and it is served by the platform.

The route takes TemplateInput and returns a card whose body is ExtractionTemplate.

Request body#

The request body is TemplateInput.

field	type	required	note
`template`	ExtractionTemplate	yes
`flow`	`one of write \| preview \| arm \| disarm \| retire`	yes

Response#

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

Example#

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

Example

curl -X POST https://api.scaleintelligence.co/v1/act/scrape_template \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "template": { "name": "…", "page_kind": "listing", "scope": { "seeds": [], "allow_patterns": [], "deny_patterns": [], "max_depth": 0, "max_pages": 0, "use_sitemap": false }, "render": "static", "navigation": [], "fields": [], "normalisation": [], "dedup_key": [], "source_object": "…", "filter": { "allow_types": [], "deny_types": [], "allow_patterns": [], "deny_patterns": [], "render": "static" }, "freshness": "…", "attempt_caps": {}, "budget": {}, "state": { "ready": false, "since": "…" } }, "flow": "write" }'

import { client } from "@scale/sdk";
const answer = await client.act.scrape_template({
    "template": {
      "name": "…",
      "page_kind": "listing",
      "scope": {
        "seeds": [],
        "allow_patterns": [],
        "deny_patterns": [],
        "max_depth": 0,
        "max_pages": 0,
        "use_sitemap": false
      },
      "render": "static",
      "navigation": [],
      "fields": [],
      "normalisation": [],
      "dedup_key": [],
      "source_object": "…",
      "filter": {
        "allow_types": [],
        "deny_types": [],
        "allow_patterns": [],
        "deny_patterns": [],
        "render": "static"
      },
      "freshness": "…",
      "attempt_caps": {},
      "budget": {},
      "state": {
        "ready": false,
        "since": "…"
      }
    },
    "flow": "write"
  });
// answer.body is a ExtractionTemplate. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/act/scrape_template",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "template": {
        "name": "…",
        "page_kind": "listing",
        "scope": {
          "seeds": [],
          "allow_patterns": [],
          "deny_patterns": [],
          "max_depth": 0,
          "max_pages": 0,
          "use_sitemap": false
        },
        "render": "static",
        "navigation": [],
        "fields": [],
        "normalisation": [],
        "dedup_key": [],
        "source_object": "…",
        "filter": {
          "allow_types": [],
          "deny_types": [],
          "allow_patterns": [],
          "deny_patterns": [],
          "render": "static"
        },
        "freshness": "…",
        "attempt_caps": {},
        "budget": {},
        "state": {
          "ready": false,
          "since": "…"
        }
      },
      "flow": "write"
    }).json()

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

MCP tool#

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

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

{
  "template": {
    "name": "…",
    "page_kind": "listing",
    "scope": {
      "seeds": [],
      "allow_patterns": [],
      "deny_patterns": [],
      "max_depth": 0,
      "max_pages": 0,
      "use_sitemap": false
    },
    "render": "static",
    "navigation": [],
    "fields": [],
    "normalisation": [],
    "dedup_key": [],
    "source_object": "…",
    "filter": {
      "allow_types": [],
      "deny_types": [],
      "allow_patterns": [],
      "deny_patterns": [],
      "render": "static"
    },
    "freshness": "…",
    "attempt_caps": {},
    "budget": {},
    "state": {
      "ready": false,
      "since": "…"
    }
  },
  "flow": "write"
}

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

Claims#

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