---
title: "ask: propose template"
description: "a `ProposeTemplateInput` to a draft template with fields and evidence spans for the person to confirm"
section: reference
address: /reference/ask/propose_template
contract: 0476e35e6e275db5
---

# ask: propose template

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

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

<span class="op-method">POST</span><span class="op-path">/v1/ask/propose_template</span><span class="op-note">a task, 202</span>

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](/concepts/proposetemplateinput) and returns a card whose body is [ExtractionTemplate](/concepts/extractiontemplate).



## Request body
The request body is [ProposeTemplateInput](/concepts/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](/concepts/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/<id>, then /brand/<id>, then /strategy/<id> |
| `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.

<details class="wire"><summary>Example</summary>





```sh
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": [] }'
```




```typescript
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.
```




```python
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()
```




```rust
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?;
```




</details>

## 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](/reference/tools/si-ask-propose_template) describes it.
