read: catalogue.

A tenant or a brand to every source and connector with its kinds of reading and action, its state, the identity it needs, its cost, its rights, its coverage and its health

Request body#

The request body is CatalogueInput.

Response#

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

A caller needs the tenant rung and a token with the read grant. The platform serves this route.

Example#

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

curl -X POST https://api.scaleintelligence.co/v1/read/catalogue \
  -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.catalogue({});
// answer.body is a [SourceCatalogueEntry]. answer.foot holds the basis, the scope and the time.

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

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

MCP tool#

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

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

{}