TypeScript SDK - Blankstate

Install via npm or your preferred package manager.

npm install @blankstate/sdk

Initialise

import { Blankstate } from "@blankstate/sdk";

const bks = new Blankstate({ token: process.env.BLANKSTATE_API_TOKEN! });

The token comes from the Atlas API Dashboard. apiUrl defaults to https://ibf.blankstate.ai.

Sense

Protocol id and content are positional; the id carries an optional version (name:version, defaults to latest).

const result = await bks.sense(
  "customer-service-quality:1.0",
  "I understand your concern about the billing discrepancy — let me resolve this now.",
  { profile: "detailed" },
);

console.log(result.score);      // 0.74
console.log(result.resonance);  // per-metamarker resonance + evidence

Sense against several protocols

const results = await bks.senseMultiple(
  ["empathy:1.0", "compliance:2.0"],
  "...content...",
);
for (const [id, r] of results) console.log(id, r.score);

Fidelity check (0 ICS)

Confirm a protocol can read the content before spending ICS on a full measurement.

const fit = await bks.fidelityCheck("customer-service-quality:1.0", "...content...");
console.log(fit.fidelity); // 0–1 confidence the protocol applies

Usage & protocols

const balance = await bks.usage();        // ICS quota / used / remaining
const list = await bks.protocols();       // protocols visible to this token
const def = await bks.protocol("customer-service-quality:1.0");

Error handling

import { BlankstateAPIError } from "@blankstate/sdk";

try {
  const result = await bks.sense("customer-service-quality:1.0", "...");
} catch (err) {
  if (err instanceof BlankstateAPIError) {
    if (err.isQuotaError()) console.error("ICS quota exhausted", err.icsInfo);
    else console.error(err.statusCode, err.code, err.errorMessage);
  }
}