Docs / Reference / ask: get content

ask: get content.

A `ContentRequest` to a `ContentResponse`, the page in bronze

Figure 1POST /v1/ask/get_contentspecified

The caller sends ContentRequest to /v1/ask/get_content. The platform returns a card whose body is ContentResponse.

POST/v1/ask/get_contenta task, 202

Get content. 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 ContentRequest and returns a card whose body is ContentResponse.

Request body#

The request body is ContentRequest.

field	type	required	note
`address`	`text`	yes
`returns`	`[one of article \| html \| markdown \| text \| links \| metadata \| stylesheets \| scripts \| images \| screenshot \| pdf \| network events]`	yes	article is the main content with its title, author, published time and language, as CrawlKit’s extractor returns it
`filter`	ResourceFilter	yes
`as_identity`	`id`	no	a held identity, lent by a grant: its cookie jar, session token, access token or API key
`proxy_policy`	ProxyPolicy	no
`wait_for`	`text`	no	a selector or a time
`cache_for`	`duration`	no
`credit_cells`	`[id]`	no

Response#

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

Example

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

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

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

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

MCP tool#

The MCP tool si.ask.get_content 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/ContentResponse. The tool’s page describes it.

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

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

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

Claims#

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