Scale Intelligence■ Docs
Docs / Reference / work: browse open

work: browse open.

A `BrowseOpenInput` to the session, opened, with its live view

Figure 1POST /v1/work/browse_openspecified
CALLERyour app or an agentholds the keyAPI GATEWAY/v1/work/browse_open4 headersCORE: WORKrung strategygrant workRECORDreads or writesTASK, 202body BrowsingSessionThe input is BrowseOpenInput. Every response carries the contract's hash.flows forwardthe result
The caller sends BrowseOpenInput to /v1/work/browse_open. The platform returns a card whose body is BrowsingSession.
POST/v1/work/browse_opena task, 202

Open a browsing session. 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 BrowseOpenInput and returns a card whose body is BrowsingSession.

Request body#

The request body is BrowseOpenInput.

fieldtyperequirednote
strategyidno
identityidno
proxy_policyProxyPolicyno
filterResourceFilterno
live_viewboolyes

Response#

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

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 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 BrowseOpenInput allows. The build validates it against the schema of BrowseOpenInput.

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

MCP tool#

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

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

{
  "live_view": false
}
Without a key, this page shows the request only. The request body is BrowseOpenInput, and the route returns a card whose body is BrowsingSession.

Claims#

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