read: candidates.

Reads the candidates of one brand, narrowed by a buyer profile or by a place to Each candidate arrives with the signals gathered about it, the rung it has reached, and what it still lacks to qualify

Request body#

The request body is CandidatesInput.

Response#

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

Example#

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

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

import { client } from "@scale/sdk";
const answer = await client.read.candidates({
    "brand": "…"
  });
// answer.body is a [Candidate]. answer.foot holds the basis, the scope and the time.

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

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

MCP tool#

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

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

{
  "brand": "…"
}