API Reference

The Auditail SDK exposes a single client class — Auditail — with a minimal, composable API.

---

Initialization

TypeScript

import { Auditail } from 'auditail-sdk';

const aegis = new Auditail({
  apiKey: 'your_key',           // required
  environment: 'production',    // optional, default: 'production'
  logLevel: 'info',             // optional: 'debug' | 'info' | 'warn' | 'error' | 'silent'
  baseUrl: 'https://...',       // optional: for private cloud deployments
});

Python

from auditail import Auditail

aegis = Auditail(
    api_key="your_key",           # required
    environment="production",     # optional, default: 'production'
    log_level="info",             # optional: 'debug' | 'info' | 'warn' | 'error' | 'silent'
    base_url="https://...",       # optional: for private cloud deployments
)

---

Methods

Method	Description
aegis.guard()	Evaluate an agent action against all rules and log an audit event.
aegis.addRule(rule)	Register a single guardrail rule.
aegis.addRules(rules)	Register multiple guardrail rules.
aegis.getAuditLog()	Return all audit events from this session.

Static Helpers

Property	Description
Auditail.rules.noExternalEmail()	Pre-built rule: block outbound emails.
Auditail.rules.noDataDeletion()	Pre-built rule: block destructive SQL.
Auditail.rules.noExternalApiCalls()	Pre-built rule: alert on outbound HTTP.

---

TypeScript Types

import type {
  AuditailConfig,
  GuardOptions,
  GuardResult,
  GuardrailRule,
  AuditEvent,
} from 'auditail-sdk';