ask: read source.

The installed connector, the kind, a cursor to a page of source objects, the next cursor, the cells credited

Request body#

The request body is ReadSourceInput.

Response#

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

A caller needs the strategy rung and a token with the ask grant. The platform or the desktop app serves this route.

Example#

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

curl -X POST https://api.scaleintelligence.co/v1/ask/read_source \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "installed_connector": "…", "kind_of_reading": "…" }'

import { client } from "@scale/sdk";
const answer = await client.ask.read_source({
    "installed_connector": "…",
    "kind_of_reading": "…"
  });
// answer.body is a ReadSourcePage. answer.foot holds the basis, the scope and the time.

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

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

MCP tool#

The MCP tool si.ask.read_source 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/ReadSourcePage. The tool’s page describes it.

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

{
  "installed_connector": "…",
  "kind_of_reading": "…"
}