files: download.

A file's pointer from a task or a document, and where in the workspace to put it to progress by bytes moved of bytes in all, then the path inside the workspace

Request body#

The request body is DownloadInput.

Response#

The route returns a card whose body is FileTransfer. 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#

A caller needs the user rung and a token with the files grant. The desktop app serves this route.

Example#

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

curl -X POST https://api.scaleintelligence.co/v1/files/download \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "pointer": "…" }'

import { client } from "@scale/sdk";
const answer = await client.files.download({
    "pointer": "…"
  });
// answer.body is a FileTransfer. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/files/download",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "pointer": "…"
    }).json()

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

MCP tool#

The MCP tool si.files.download 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/FileTransfer. The tool’s page describes it.

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

{
  "pointer": "…"
}