Scale Intelligence■ Docs
Docs / Reference / read: lookup

read: lookup.

A key: a namespace with a value, or a name with a place, and with a name a breadth.

Figure 1POST /v1/read/lookupspecified
CALLERyour app or an agentholds the keyAPI GATEWAY/v1/read/lookup4 headersCORE: READrung strategygrant readRECORDreads or writesCARD, 200body LookupAnswerThe input is LookupInput. Every response carries the contract's hash.flows forwardthe result
The caller sends LookupInput to /v1/read/lookup. The platform returns a card whose body is LookupAnswer.
POST/v1/read/lookup

Look up. The call needs the strategy rung under a token with the read grant, and it is served by the platform.

The route takes LookupInput and returns a card whose body is LookupAnswer.

Request body#

The request body is LookupInput.

fieldtyperequirednote
namespacetextno
valuetextno
nametextno
placetextno
kindKindOfEntityno
breadthone of exact | similar | related | broadnowith a name: the one candidate search of the record at that breadth, by exact keys, names and meaning, in place of the substring match

Response#

The route returns a card whose body is LookupAnswer. 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 strategy rung and a token with the read grant. The platform serves this route.

Example#

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

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

MCP tool#

The MCP tool si.read.lookup 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/LookupAnswer. The tool’s page describes it.

POST /v1/read/lookup
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 LookupInput, and the route returns a card whose body is LookupAnswer.

Claims#

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