---
title: "act: scrape template"
description: "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"
section: reference
address: /reference/act/scrape_template
contract: 0476e35e6e275db5
---
# 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: 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](/concepts/templateinput) and returns a card whose body is [ExtractionTemplate](/concepts/extractiontemplate).
## Request body
The request body is [TemplateInput](/concepts/templateinput).
| field | type | required | note |
|---|---|---|---|
| `template` | [ExtractionTemplate](/concepts/extractiontemplate) | yes | |
| `flow` | `one of write \| preview \| arm \| disarm \| retire` | yes | |
## 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.
## 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
```sh
curl -X POST https://api.scaleintelligence.co/v1/act/scrape_template \
-H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/" \
-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" }'
```
```typescript
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.
```
```python
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/act/scrape_template",
headers={"Scale-Key": KEY, "Scale-Scope": "tenant/"},
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()
```
```rust
let answer: Card = client.post("https://api.scaleintelligence.co/v1/act/scrape_template")
.header("Scale-Key", key).header("Scale-Scope", "tenant/")
.json(&TemplateInput { /* the fields of the page */ }).send().await?.json().await?;
```