Introduction

OpenRedaction Documentation

Welcome to the OpenRedaction documentation. OpenRedaction is an open-source PII (Personally Identifiable Information) detection and redaction library with optional AI assist.

What is OpenRedaction?

OpenRedaction is a regex-first PII redaction engine that:

  • Detects PII using 500+ tested regex patterns
  • Redacts sensitive data with configurable strategies
  • Optional AI assist for better detection on unstructured text
  • Self-hostable for complete privacy and control
  • Open source and free to use

Quick Start

npm install openredaction
import { redact } from 'openredaction';
 
const text = "My name is John Doe and my email is john@example.com";
const result = await redact(text);
console.log(result.redacted_text);
// "My name is [REDACTED] and my email is [REDACTED]"

Key Features

  • Regex-first detection - Transparent, deterministic, and fast
  • Optional AI assist - Better coverage on messy, unstructured text
  • Self-hostable - Run entirely on your infrastructure
  • Privacy-first - No data leaves your environment by default
  • GDPR/HIPAA/CCPA ready - Built for compliance

Next Steps

API Documentation

Resources

Getting Started
OpenRedaction Documentation © 2025