Scale Intelligence■ Docs
Docs / Reference / files: workspace

files: workspace.

Nothing, or a folder to make the workspace to the workspace folder, and every act the app made in it on the ledger

Figure 1POST /v1/files/workspacespecified
CALLERyour app or an agentholds the keyAPI GATEWAY/v1/files/workspace4 headersCORE: FILESrung usergrant filesRECORDreads or writesCARD, 200body WorkspaceThe input is Nothing. Every response carries the contract's hash.flows forwardthe result
The caller sends Nothing to /v1/files/workspace. The platform returns a card whose body is Workspace.
POST/v1/files/workspace

From the local server’s own. The call needs the user rung under a token with the files grant, and it is served by the installed app.

The route takes an empty body and returns a card whose body is Workspace.

Request body#

The request body is empty.

Response#

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

headerrequiredmeaning
Scale-Scopeyesthe scope the call runs in: tenant/, then /brand/, then /strategy/
Scale-As-True-Onnothe date the facts must have been true on; defaults to now
Scale-As-Known-Onnothe date the facts must have been known on; defaults to now
Scale-Keynofor 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 user rung and a token with the files grant. The desktop app serves this route.

Example#

The example sends an empty body.

Example
curl -X POST https://api.scaleintelligence.co/v1/files/workspace \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{}'
import { client } from "@scale/sdk";
const answer = await client.files.workspace({});
// answer.body is a Workspace. answer.foot holds the basis, the scope and the time.
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/files/workspace",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={}).json()
let answer: Card = client.post("https://api.scaleintelligence.co/v1/files/workspace")
    .header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
    .json(&()).send().await?.json().await?;

MCP tool#

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

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

{}
Without a key, this page shows the request only. The request body is Nothing, and the route returns a card whose body is Workspace.

Claims#

claimstateroute or tool
The platform serves the route /v1/files/workspace at contract 0476e35e6e275db5.target/v1/files/workspace