Integrate Redactorr into your application with our REST API, JavaScript SDK, or web app at app.redactorr.com.

Enterprise API access is planned for a future release.

Send HTTP requests to detect and redact sensitive data.

Use cases:

• Backend services
• CI/CD pipelines
• Batch processing
• Serverless functions

Enterprise API access is planned for a future release. Contact [email protected] to register your interest.

Use Redactorr in Node.js or browser applications.

Use cases:

• Web applications
• Electron apps
• Chrome extensions
• Node.js scripts

Example:

import { Redactorr } from '@redactorr/sdk';

const client = new Redactorr({
  apiKey: process.env.REDACTORR_API_KEY
});

const result = await client.detectAndRedact({
  text: 'Contact [email protected]',
  mode: 'balanced'
});

Add Redactorr to your browser for on-the-fly redaction.

Use cases:

• Email clients (Gmail, Outlook)
• Slack/Discord
• Google Docs
• CRM systems

Install:

• Chrome: Chrome Web Store
• Firefox: Firefox Add-ons
• Edge: Edge Add-ons

Receive real-time notifications when events occur.

Use cases:

• Audit logging
• Compliance monitoring
• Automated workflows
• Alerting

Events:

• detection.completed
• file.processed
• breach.found
• pattern.created

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Get your API key from Settings > API Keys.

POST /v1/detect

Detect sensitive data in text.

Request:

{
  "text": "Contact [email protected]",
  "mode": "balanced",
  "categories": ["EMAIL", "PHONE", "SSN"]
}

Response:

{
  "detections": [
    {
      "type": "EMAIL",
      "value": "[email protected]",
      "start": 8,
      "end": 25,
      "confidence": 0.98
    }
  ]
}

POST /v1/redact

Redact sensitive data and return redaction map.

Request:

{
  "text": "Contact [email protected]",
  "mode": "balanced"
}

Response:

{
  "redacted": "Contact [EMAIL_1]",
  "tokenMap": {
    "EMAIL_1": "[email protected]"
  }
}

POST /v1/restore

Restore original values from redaction map.

Request:

{
  "text": "Contact [EMAIL_1]",
  "tokenMap": {
    "EMAIL_1": "[email protected]"
  }
}

Response:

{
  "restored": "Contact [email protected]"
}

npm install @redactorr/sdk
# or
yarn add @redactorr/sdk
# or
pnpm add @redactorr/sdk

Enterprise API access is planned for a future release.