Docs / Reference / ask: propose template

ask: propose template.

A `ProposeTemplateInput` to a draft template with fields and evidence spans for the person to confirm

Figure 1POST /v1/ask/propose_templatespecified

The caller sends ProposeTemplateInput to /v1/ask/propose_template. The platform returns a card whose body is ExtractionTemplate.

POST/v1/ask/propose_templatea task, 202

Propose a scrape template from a sample page. 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 ProposeTemplateInput and returns a card whose body is ExtractionTemplate.

Request body#

The request body is ProposeTemplateInput.

field	type	required	note
`address`	`text`	yes
`page_kind`	`one of listing \| detail \| feed \| table \| search results \| infinite scroll \| document \| API response`	yes
`marked`	`[text]`	yes	the values the person pointed at
`as_identity`	`id`	no

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. 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 ProposeTemplateInput allows. The build validates it against the schema of ProposeTemplateInput.

Example

curl -X POST https://api.scaleintelligence.co/v1/ask/propose_template \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "address": "…", "page_kind": "listing", "marked": [] }'

import { client } from "@scale/sdk";
const answer = await client.ask.propose_template({
    "address": "…",
    "page_kind": "listing",
    "marked": []
  });
// 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/ask/propose_template",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "address": "…",
      "page_kind": "listing",
      "marked": []
    }).json()

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

MCP tool#

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

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

{
  "address": "…",
  "page_kind": "listing",
  "marked": []
}

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

Claims#

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