Docs / Reference / ask: scrape

ask: scrape.

A `ScrapeRequest` to a `ScrapeResult`, the rows as source objects with their evidence spans

Figure 1POST /v1/ask/scrapespecified

The caller sends ScrapeRequest to /v1/ask/scrape. The platform returns a card whose body is ScrapeResult.

POST/v1/ask/scrapea task, 202

Scrape. The call needs the strategy rung under a token with the ask grant, and it is served by either, by the size bound.

The route takes ScrapeRequest and returns a card whose body is ScrapeResult.

Request body#

The request body is ScrapeRequest.

field	type	required	note
`template`	`id`	no	an extraction template; any of its parts may be overridden below
`scope`	CrawlScope	no	required when no template
`fields`	FieldSpec	no	declared selectors
`schema`	`json`	no	for the model-assisted reader, every value with its evidence span or refused
`source_object`	SourceObject	yes	declared inline for one scrape, or a registered row
`mapping`	Mapping	no
`filter`	ResourceFilter	yes
`as_identity`	`id`	no
`proxy_policy`	ProxyPolicy	no
`credit_cells`	`[id]`	no
`asked_by`	`text`	no	who asked for the run, as the caller’s kind, or the crawler for an address a walk found; the beat takes what a person or the agent asked before the crawler’s own discoveries, oldest first within each

Response#

The route returns a card whose body is ScrapeResult. 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. This route runs as a long step and returns a task with status 202. POST /v1/work/status returns the task’s progress, and POST /v1/work/cancel stops the task.

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 ask grant. The platform or the desktop app serves this route.

Example#

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

Example

curl -X POST https://api.scaleintelligence.co/v1/ask/scrape \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "source_object": "…", "filter": { "allow_types": [], "deny_types": [], "allow_patterns": [], "deny_patterns": [], "render": "static" } }'

import { client } from "@scale/sdk";
const answer = await client.ask.scrape({
    "source_object": "…",
    "filter": {
      "allow_types": [],
      "deny_types": [],
      "allow_patterns": [],
      "deny_patterns": [],
      "render": "static"
    }
  });
// answer.body is a ScrapeResult. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/ask/scrape",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "source_object": "…",
      "filter": {
        "allow_types": [],
        "deny_types": [],
        "allow_patterns": [],
        "deny_patterns": [],
        "render": "static"
      }
    }).json()

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

MCP tool#

The MCP tool si.ask.scrape takes the same input and returns the same card. The tool only reads data. An MCP host that renders cards draws this card from ui://scale-intelligence/cards/ScrapeResult. The tool’s page describes it.

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

{
  "source_object": "…",
  "filter": {
    "allow_types": [],
    "deny_types": [],
    "allow_patterns": [],
    "deny_patterns": [],
    "render": "static"
  }
}

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

Claims#

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