TypeScript SDK

npm install superagent-ai
# or
pnpm add superagent-ai
# or
yarn add superagent-ai

import { createClient } from "superagent-ai";

const client = createClient({
  apiBaseUrl: process.env.SUPERAGENT_API_BASE_URL, // Optional, defaults to https://app.superagent.sh/api
  apiKey: process.env.SUPERAGENT_API_KEY!,
});

// Guard: Analyze commands for security threats
const guardResult = await client.guard("Write a hello world script", {
  onBlock: (reason) => {
    console.warn("Guard blocked command:", reason);
  },
  onPass: () => {
    console.log("Guard approved command!");
  },
});

if (guardResult.rejected) {
  console.log("Blocked:", guardResult.reasoning);
} else {
  console.log("Approved");
}

// Redact: Remove sensitive data from text
const redactResult = await client.redact(
  "My email is john@example.com and SSN is 123-45-6789"
);

console.log(redactResult.redacted);
// Output: "My email is <REDACTED_EMAIL> and SSN is <REDACTED_SSN>"

// Verify: Check claims against source materials
const verifyResult = await client.verify(
  "The company was founded in 2020 and has 500 employees",
  [
    {
      name: "About Us",
      content: "Founded in 2020, our company has grown rapidly...",
      url: "https://example.com/about"
    },
    {
      name: "Team Page",
      content: "We currently have over 450 team members...",
      url: "https://example.com/team"
    }
  ]
);

console.log(verifyResult.claims);
// Output: Array of claim verifications with verdicts, evidence, and reasoning

const client = createClient({
  apiKey: process.env.SUPERAGENT_API_KEY!,
});

const result = await client.verify(
  "The company was founded in 2020 and has 500 employees.",
  [
    {
      name: "About Us",
      content: "Founded in 2020, our company has grown rapidly...",
      url: "https://example.com/about"
    },
    {
      name: "Team Page",
      content: "We currently have over 450 team members...",
      url: "https://example.com/team"
    }
  ]
);

// Iterate through claims to check verdicts
for (const claim of result.claims) {
  console.log(`Claim: ${claim.claim}`);
  console.log(`Verdict: ${claim.verdict ? '✓ True' : '✗ False'}`);
  console.log(`Evidence: ${claim.evidence}`);
  console.log(`Reasoning: ${claim.reasoning}`);
  console.log(`Sources: ${claim.sources.map(s => s.name).join(', ')}`);
  console.log('---');
}

const client = createClient({
  apiKey: process.env.SUPERAGENT_API_KEY!,
});

const result = await client.redact(
  "My credit card is 4532-1234-5678-9010 and my email is john@example.com",
  { entities: ["credit card numbers", "email addresses"] }
);
// The model will redact the specified entity types based on your natural language descriptions

const client = createClient({
  apiKey: process.env.SUPERAGENT_API_KEY!,
});

const result = await client.redact(
  "Check out https://github.com/user/repo and https://secret.com/data",
  { urlWhitelist: ["https://github.com", "https://example.com"] }
);
// Output: "Check out https://github.com/user/repo and <URL_REDACTED>"

import { readFileSync, writeFileSync } from 'fs';

const client = createClient({
  apiKey: process.env.SUPERAGENT_API_KEY!,
});

// Read PDF file
const pdfBuffer = readFileSync('sensitive-document.pdf');
const pdfBlob = new Blob([pdfBuffer], { type: 'application/pdf' });

// Get redacted PDF file
const result = await client.redact(
  pdfBlob,  // Pass file as first parameter
  {
    format: "pdf",  // Returns redacted PDF
    entities: ["SSN", "credit card numbers", "email addresses"]
  }
);

// Save the redacted PDF
if (result.pdf) {
  const arrayBuffer = await result.pdf.arrayBuffer();
  writeFileSync('redacted-output.pdf', Buffer.from(arrayBuffer));
  console.log('Redacted PDF saved to redacted-output.pdf');
}

import { readFileSync } from 'fs';

const client = createClient({
  apiKey: process.env.SUPERAGENT_API_KEY!,
});

const pdfBuffer = readFileSync('sensitive-document.pdf');
const pdfBlob = new Blob([pdfBuffer], { type: 'application/pdf' });

// Get redacted text from PDF
const result = await client.redact(
  pdfBlob,  // Pass file as first parameter
  {
    format: "json",  // Returns JSON with redacted text (default)
    entities: ["SSN", "credit card numbers", "email addresses"]
  }
);

console.log(result.redacted);  // Redacted text extracted from the PDF
console.log(result.reasoning); // Explanation of what was redacted

import { createClient } from "superagent-ai";
import { readFileSync } from 'fs';

const client = createClient({
  apiKey: process.env.SUPERAGENT_API_KEY!,
});

// Read PDF file
const pdfBuffer = readFileSync('document.pdf');
const pdfBlob = new Blob([pdfBuffer], { type: 'application/pdf' });

// Analyze PDF file for security threats
const result = await client.guard(
  pdfBlob,  // Pass file as first parameter
  {
    onBlock: (reason) => console.warn("Guard blocked:", reason),
    onPass: () => console.log("Guard approved!"),
  }
);

// Check the analysis result
if (result.rejected) {
  console.log(`Document contains security threats: ${result.reasoning}`);
  if (result.decision) {
    console.log(`Violation types: ${result.decision.violation_types}`);
    console.log(`CWE codes: ${result.decision.cwe_codes}`);
  }
} else {
  console.log(`Document is safe: ${result.reasoning}`);
}

import { GuardError } from "superagent-ai";

try {
  const result = await client.guard("command");
} catch (error) {
  if (error instanceof GuardError) {
    console.error("Guard error:", error.message);
  }
}