Docs / Reference / work: download set

work: download set.

A `DownloadInput` to `DownloadJob` rows, one per file

Figure 1POST /v1/work/download_setspecified

The caller sends DownloadSetInput to /v1/work/download_set. The platform returns a card whose body is [DownloadJob].

POST/v1/work/download_seta task, 202

Download files. The call needs the strategy rung under a token with the work grant, and it is served by either, by the size bound.

The route takes DownloadSetInput and returns a card whose body is DownloadJob.

Request body#

The request body is DownloadSetInput.

field	type	required	note
`addresses`	`[text]`	yes
`session`	`id`	no	the browsing session whose cookies serve
`identity`	`id`	no
`filter`	ResourceFilter	yes
`destination`	`one of bronze \| the workspace`	yes

Response#

The route returns a card whose body is DownloadJob. 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 work grant. The platform or the desktop app serves this route.

Example#

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

Example

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

import { client } from "@scale/sdk";
const answer = await client.work.download_set({
    "addresses": [],
    "filter": {
      "allow_types": [],
      "deny_types": [],
      "allow_patterns": [],
      "deny_patterns": [],
      "render": "static"
    },
    "destination": "bronze"
  });
// answer.body is a [DownloadJob]. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/work/download_set",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "addresses": [],
      "filter": {
        "allow_types": [],
        "deny_types": [],
        "allow_patterns": [],
        "deny_patterns": [],
        "render": "static"
      },
      "destination": "bronze"
    }).json()

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

MCP tool#

The MCP tool si.work.download_set 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/DownloadJob. The tool’s page describes it.

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

{
  "addresses": [],
  "filter": {
    "allow_types": [],
    "deny_types": [],
    "allow_patterns": [],
    "deny_patterns": [],
    "render": "static"
  },
  "destination": "bronze"
}

Without a key, this page shows the request only. The request body is DownloadSetInput, and the route returns a card whose body is [DownloadJob].

Claims#

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