Redaction API Reference

// Uses the built-in fetch API (Node.js 18+ or any modern browser context)
const API_URL = 'https://www.redactionapi.net/api/redact.php';
const API_KEY = 'your_api_key_here';

async function redactText(text, entities) {
  const response = await fetch(API_URL, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      text: text,
      api_key: API_KEY,
      api_type: 'anonymization',
      entities: entities,
      mask_mode: 'replace'
    })
  });

  const result = await response.json();

  // Errors are reported in the JSON body via "status" / "error"
  if (result.status !== 200) {
    throw new Error(`API error ${result.status}: ${result.error}`);
  }

  return result;
}

// Example usage
(async () => {
  const result = await redactText(
    'Contact [email protected] or call 555-123-4567',
    ['PII', 'EMAIL', 'PHONE']
  );

  console.log('Anonymized:', result.anonymized_text);
  console.log('Entities:', result.detected_entities);
  console.log('Words remaining:', result.remaining_words);
})();

curl -X POST https://www.redactionapi.net/api/redact.php \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Employee Sarah Johnson ([email protected])\nSSN: 123-45-6789\nPhone: +1 (555) 123-4567\nCredit Card: 4111 1111 1111 1111\nIP: 192.168.1.42",
    "api_key": "your_api_key_here",
    "api_type": "anonymization",
    "entities": [
      "PII",
      "EMAIL",
      "PHONE",
      "CREDIT_CARD",
      "SSN",
      "IP_ADDRESS"
    ],
    "mask_mode": "replace"
  }'

<?php

$apiUrl = 'https://www.redactionapi.net/api/redact.php';
$apiKey = 'your_api_key_here';

$payload = json_encode([
    'text'     => 'Contact [email protected], SSN: 123-45-6789',
    'api_key'  => $apiKey,
    'api_type' => 'anonymization',
    'entities' => ['PII', 'EMAIL', 'SSN', 'PHONE'],
    'mask_mode' => 'replace'
]);

$ch = curl_init($apiUrl);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST           => true,
    CURLOPT_POSTFIELDS     => $payload,
    CURLOPT_HTTPHEADER     => [
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);

// Errors are reported in the JSON body via "status" / "error"
if (isset($result['status']) && $result['status'] === 200) {
    echo "Anonymized: " . $result['anonymized_text'] . "\n";
    echo "Entities detected: " . $result['entities_detected'] . "\n";
    echo "Words remaining: " . $result['remaining_words'] . "\n";
} else {
    echo "Error: " . ($result['error'] ?? 'unknown') . "\n";
}

?>

import java.net.http.*;
import java.net.URI;

public class RedactionApiExample {

    private static final String API_URL = "https://www.redactionapi.net/api/redact.php";
    private static final String API_KEY = "your_api_key_here";

    public static void main(String[] args) throws Exception {

        String jsonBody = """
            {
              "text": "Contact [email protected], SSN: 123-45-6789",
              "api_key": "%s",
              "api_type": "anonymization",
              "entities": ["PII", "EMAIL", "SSN", "PHONE"],
              "mask_mode": "replace"
            }
            """.formatted(API_KEY);

        HttpClient client = HttpClient.newHttpClient();

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(API_URL))
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(jsonBody))
            .build();

        HttpResponse<String> response = client.send(
            request, HttpResponse.BodyHandlers.ofString()
        );

        System.out.println("Status: " + response.statusCode());
        System.out.println("Body: " + response.body());
    }
}