read: connectors.
A tenant or a brand to every kind of reading and of action, by source, with its state, the identity it needs, its cost and its rights
Read what can be installed. The call needs the tenant rung under a token with the read grant, and it is served by the platform.
The route takes ConnectorsInput and returns a card whose body is ConnectorOffer.
Request body#
The request body is ConnectorsInput.
| field | type | required | note |
|---|---|---|---|
tenant | id | no | |
brand | id | no |
Response#
The route returns a card whose body is ConnectorOffer. 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#
| header | required | meaning |
|---|---|---|
Scale-Scope | yes | the scope the call runs in: tenant/ |
Scale-As-True-On | no | the date the facts must have been true on; defaults to now |
Scale-As-Known-On | no | the date the facts must have been known on; defaults to now |
Scale-Key | no | for 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 tenant rung and a token with the read grant. The platform serves this route.
Example#
The example sends the smallest body that ConnectorsInput allows. The build validates it against the schema of ConnectorsInput.
Example
curl -X POST https://api.scaleintelligence.co/v1/read/connectors \
-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.connectors({});
// answer.body is a ConnectorOffer. answer.foot holds the basis, the scope and the time.
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/read/connectors",
headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
json={}).json()
let answer: Card = client.post("https://api.scaleintelligence.co/v1/read/connectors")
.header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
.json(&ConnectorsInput { /* the fields of the page */ }).send().await?.json().await?;
MCP tool#
The MCP tool si.read.connectors 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/ConnectorOffer. The tool’s page describes it.
POST /v1/read/connectors
Scale-Scope: …
Scale-As-True-On: …
Scale-As-Known-On: …
Scale-Key: …
content-type: application/json
{}Claims#
| claim | state | route or tool |
|---|---|---|
| The platform serves the route /v1/read/connectors at contract 0476e35e6e275db5. | target | /v1/read/connectors |