PII Detection & Redaction API/Docs/Quickstart

Quickstart

Send your first redaction request in under 60 seconds.

1. Get an API key

Sign in to the dashboard and click Generate API key. Keys are scoped per environment (test vs. live) and can be rotated without downtime.

export SAVITAR_API_KEY=sk_live_••••••••

2. Make your first request

Redact a single text payload. The default operator replaces detected entities with typed placeholders (<PERSON_1>, <EMAIL_1>) so downstream systems can still operate on shape-preserving text.

curl -X POST "https://redact-standalone-service-5j2g6sw72a-el.a.run.app/redact" \
  -H "Authorization: Bearer $SAVITAR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "<Text>",
  "operator": "replace",
  "language": "auto",
  "entities": [
    "string"
  ],
  "session_id": "string"
}'

3. Next steps

Use the /entities endpoint to discover the full list of detectable PII types. Use /patterns to register your own detectors with regex + context tokens. Use /process to stream redaction over a PDF or Office document.