Docs / Reference / work: backfill

work: backfill.

A source, an access method, a window, a plane to the job; then partitions carrying the window

Figure 1POST /v1/work/backfillspecified

The caller sends BackfillInput to /v1/work/backfill. The platform returns a card whose body is Job.

POST/v1/work/backfilla task, 202

Run a backfill. The call needs the brand rung under a token with the work grant, and it is served by the platform.

The route takes BackfillInput and returns a card whose body is Job.

Request body#

The request body is BackfillInput.

field	type	required	note
`source`	`id`	yes
`access_method`	`id`	yes
`window`	Window	yes
`plane`	Plane	yes
`reading`	`text`	no	the hash of the procedure reading the backfill runs over, filled by the platform from the newest reading of the source through the way’s connector; a caller leaves it empty

Response#

The route returns a card whose body is Job. 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 brand rung and a token with the work grant. The platform serves this route.

Example#

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

Example

curl -X POST https://api.scaleintelligence.co/v1/work/backfill \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "source": "…", "access_method": "…", "window": { "from": "…", "to": "…" }, "plane": { "plane": "shared" } }'

import { client } from "@scale/sdk";
const answer = await client.work.backfill({
    "source": "…",
    "access_method": "…",
    "window": {
      "from": "…",
      "to": "…"
    },
    "plane": {
      "plane": "shared"
    }
  });
// answer.body is a Job. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/work/backfill",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "source": "…",
      "access_method": "…",
      "window": {
        "from": "…",
        "to": "…"
      },
      "plane": {
        "plane": "shared"
      }
    }).json()

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

MCP tool#

The MCP tool si.work.backfill takes the same input and returns the same card. The tool changes data and needs a grant. An MCP host that renders cards draws this card from ui://scale-intelligence/cards/Job. The tool’s page describes it.

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

{
  "source": "…",
  "access_method": "…",
  "window": {
    "from": "…",
    "to": "…"
  },
  "plane": {
    "plane": "shared"
  }
}

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

Claims#

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