risk-mirror-sdk
v1.0.3
Published
Risk Mirror SDK - Deterministic AI Safety Toolkit for JavaScript/TypeScript
Maintainers
Readme
Risk Mirror SDK - JavaScript/TypeScript
Deterministic, stateless safety scanning for prompts and sensitive text. No AI inference. No storage.
Installation
npm install risk-mirror-sdkAuthentication Options (choose one)
Option A: API Key (recommended for paid users)
Your API key is your license key. This ensures one shared daily quota across Website + SDK + CLI.
export RISK_MIRROR_API_KEY="your-license-key"Option B: Session Token (email login)
Use this if you want email-based auth without storing the license key locally.
export RISK_MIRROR_SESSION_TOKEN="your-session-token"Quick Start (ESM)
import RiskMirror from 'risk-mirror-sdk';
const client = new RiskMirror({
apiKey: process.env.RISK_MIRROR_API_KEY,
// or: sessionToken: process.env.RISK_MIRROR_SESSION_TOKEN,
});
const result = await client.scan('Check this text for PII and secrets');
console.log(result.verdict);Quick Start (CommonJS)
const RiskMirror = require('risk-mirror-sdk');
const client = new RiskMirror({
apiKey: process.env.RISK_MIRROR_API_KEY,
});
client.scan('Check this text for PII and secrets').then((result) => {
console.log(result.verdict);
});Safe Share
import RiskMirror from 'risk-mirror-sdk';
const client = new RiskMirror({ apiKey: process.env.RISK_MIRROR_API_KEY });
const result = await client.safeShare('sk-ABCD1234-XYZ', { mode: 'full' });
console.log(result.safe_share_text);Configuration
Custom base URL (self-hosting or local dev):
const client = new RiskMirror({
baseUrl: 'https://risk-mirror-auth.anonymous617461746174.workers.dev',
apiKey: process.env.RISK_MIRROR_API_KEY,
});Notes
- The SDK respects rate limits and will honor
Retry-Afteron 429 responses. - Default base URL points to the Risk Mirror auth worker for unified daily usage tracking.
License
MIT
