Scale Intelligence■ Docs
Docs / Reference / session: sign in

session: sign in.

Nothing, or the tenant to sign in to to the way the browser was opened, then the caller as a view once the code came back; the refresh token goes to the keychain and never to the caller

Figure 1POST /v1/session/sign_inspecified
CALLERyour app or an agentholds the keyAPI GATEWAY/v1/session/sign_in4 headersCORE: SESSIONrung usergrant readRECORDreads or writesCARD, 200body CallerThe input is SignInInput. Every response carries the contract's hash.flows forwardthe result
The caller sends SignInInput to /v1/session/sign_in. The platform returns a card whose body is Caller.
POST/v1/session/sign_in

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

The route takes SignInInput and returns a card whose body is Caller.

Request body#

The request body is SignInInput.

fieldtyperequirednote
tenantidno
tokentextnoan access token the identity provider issued, checked six ways at the face; never logged

Response#

The route returns a card whose body is Caller. 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 read grant. The desktop app serves this route.

Example#

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

Example
curl -X POST https://api.scaleintelligence.co/v1/session/sign_in \
  -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.session.sign_in({});
// answer.body is a Caller. answer.foot holds the basis, the scope and the time.
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/session/sign_in",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={}).json()
let answer: Card = client.post("https://api.scaleintelligence.co/v1/session/sign_in")
    .header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
    .json(&SignInInput { /* the fields of the page */ }).send().await?.json().await?;

MCP tool#

The MCP tool si.session.sign_in takes the same input and returns the same card. The tool only reads data. An MCP host that renders cards draws this card from ui://scale-intelligence/cards/Caller. The tool’s page describes it.

POST /v1/session/sign_in
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 SignInInput, and the route returns a card whose body is Caller.

Claims#

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