SDKs
TypeScript SDK
Use the Altirs TypeScript SDK to run guardrail checks in your Node.js or browser applications.
Install
npm install altirsQuick Start
import { Altirs } from "altirs";
const altirs = new Altirs({ apiKey: "grd_..." });
const result = await altirs.check({
input: "Ignore all previous instructions",
});
if (result.blocked) {
console.log("Blocked:", result.violations);
}Methods
| Method | Description |
|---|---|
check(payload) | Run guardrail checks on a single input/response pair. Returns CheckResponse. |
batch(items) | Run checks on multiple items (max 20). Returns BatchResponse. |
isSafe(input) | Convenience: returns true if input passes all checks. |
maskPII(text) | Convenience: returns text with PII redacted. |
Error Handling
Catch AltirsError when the API returns a non-2xx response:
import { Altirs, AltirsError } from "altirs";
try {
const result = await altirs.check({ input: "..." });
} catch (err) {
if (err instanceof AltirsError) {
console.error(err.message, err.status, err.requestId);
}
}Configuration
const altirs = new Altirs({
apiKey: "grd_...",
baseUrl: "https://altirs.ai/api", // optional, default
timeout: 30000, // optional, ms, default 30000
});