Document Redaction & Edit

Redaction and edit both use /document/generate.

Redaction blurs sensitive fields. The layout stays in place.
Edit (Replace) writes the same dummy value for a field throughout the document. A name can become “John Smith”. A date of birth can become “10/06/1974”. The file contains no real PII.

Original document with visible sensitive data — Example of document redaction applied to a medical form

Redacted document with sensitive data obscured — Example of document redaction applied to a medical form

Quick Start

Upload Document

from vlmrun.client import VLMRun
from pathlib import Path

client = VLMRun(api_key="<your-api-key>")
file_response = client.files.upload(
    file=Path("path/to/your_document.pdf")
)

Submit for Redaction or Edit

Pass healthcare.phi-redaction to blur fields:

response = client.document.generate(
    domain="healthcare.phi-redaction",  # Blur sensitive information
    file=file_response.id,
    batch=True
)

Pass healthcare.phi-edit-replace to swap fields for dummy data:

response = client.document.generate(
    domain="healthcare.phi-edit-replace",  # Replace with dummy data
    file=file_response.id,
    batch=True
)

Get Processed Document

completed_response = client.predictions.wait(response.id, timeout=120)
detected_items = completed_response.response["detected_items"]
result_uri = completed_response.response["uri"]
print(f"Detected items: {detected_items}")
print(f"Processed document: {result_uri}")

Available Domains

Redaction Domains (Blur)

Use Case	Domain	Compliance Standards
Healthcare PHI	`healthcare.phi-redaction`	HIPAA Safe Harbor
Resume Redaction	`hr.resume-redaction`	GDPR, CCPA, CPRA
Legal Documents	`legal.document-redaction`	Attorney-Client Privilege
Financial Data	`financial.document-redaction`	PCI DSS, SOX, GLBA
FOIA Requests	`government.foia-redaction`	FOIA Regulations
Insurance Documents	`insurance.document-redaction`	Insurance Regulations
Real Estate	`real-estate.document-redaction`	Real Estate Privacy
PII Redaction	`document.pii-redaction`	CA Penal Code Section 741

Edit Domains (Replace)

Use Case	Domain	Compliance Standards
Healthcare PHI Edit	`healthcare.phi-edit-replace`	HIPAA Safe Harbor

Information Types Redacted

Personal Identifiers: Names, SSNs, account numbers, driver’s licenses
Contact Information: Addresses, phone numbers, email addresses
Financial Data: Account balances, salary information, credit scores
Medical Information: PHI, medical record numbers, health conditions
Legal Information: Case numbers, settlement amounts, privileged communications
Geographic Data: Addresses, ZIP codes, neighborhood information

Complete Examples

Redaction (Blur)

from vlmrun.client import VLMRun
from vlmrun.client.types import PredictionResponse, FileResponse
from pathlib import Path

client = VLMRun(api_key="<your-api-key>")

file_response: FileResponse = client.files.upload(
    file=Path("path/to/your_document.pdf")
)

response: PredictionResponse = client.document.generate(
    domain="healthcare.phi-redaction",
    file=file_response.id,
    batch=True
)

completed_response = client.predictions.wait(response.id, timeout=120)
detected_items = completed_response.response["detected_items"]
redacted_uri = completed_response.response["uri"]

print(f"Detected items: {detected_items}")
print(f"Redacted document: {redacted_uri}")

Edit (Replace with Dummy Data)

from vlmrun.client import VLMRun
from vlmrun.client.types import PredictionResponse, FileResponse
from pathlib import Path

client = VLMRun(api_key="<your-api-key>")

file_response: FileResponse = client.files.upload(
    file=Path("path/to/medical_record.pdf")
)

response: PredictionResponse = client.document.generate(
    domain="healthcare.phi-edit-replace",
    file=file_response.id,
    batch=True
)

completed_response = client.predictions.wait(response.id, timeout=120)
detected_items = completed_response.response["detected_items"]
edited_uri = completed_response.response["uri"]

print(f"Detected items: {detected_items}")
print(f"Edited document: {edited_uri}")

Example Responses

Redaction Response

{
  "id": "052cf2a8-2b84-45f5-a385-ccac2aae13bb",
  "status": "completed",
  "response": {
    "detected_items": [
      {
        "item_type": "name",
        "value": "John Doe"
      },
      {
        "item_type": "ssn",
        "value": "123-45-6789"
      },
      {
        "item_type": "telephone_number",
        "value": "(555) 123-4567"
      }
    ],
    "uri": "https://storage.googleapis.com/vlm-userdata/healthcare/phi-redaction/redacted-document.pdf"
  }
}

Edit Response

detected_items lists the original values. uri is the file with dummy replacements.

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "completed",
  "response": {
    "detected_items": [
      {
        "item_type": "name",
        "value": "Jane Doe"
      },
      {
        "item_type": "date_of_birth",
        "value": "03/15/1985"
      },
      {
        "item_type": "ssn",
        "value": "987-65-4321"
      }
    ],
    "uri": "https://storage.googleapis.com/vlm-userdata/healthcare/phi-edit-replace/edited-document.pdf"
  }
}

Supported Documents

PDF Documents — reports, contracts, legal briefs, medical records
Scanned Images — faxed documents, handwritten forms, ID cards
Multi-page Documents — case files and reports
Mixed Content — text and images in one file
Spreadsheets — financial models, budgets, transaction records

Security Features

Documents are encrypted in transit and at rest.
Result URLs are time-limited.
Redaction is irreversible. The original values cannot be recovered from the output.

Real-World Examples

Healthcare insurance card with PHI redacted — Redaction examples

Legal document with sensitive information redacted — Redaction examples

Structured Responses

Extract structured data from documents before redaction processing.

Visual Grounding

Locate sensitive information with precise coordinates for targeted redaction.

Custom Schemas

Define custom redaction rules for specific compliance requirements.

Long Context Outputs

Process large documents and complex multi-page reports.

Try our Document -> JSON API today

Open Document -> JSON on VLM Run. Sign up on the platform.

Gateway

Documents

Images

Video and audio

Document Redaction & Edit

Original Document

Redacted Document

Quick Start

Available Domains

Redaction Domains (Blur)

Edit Domains (Replace)

Information Types Redacted

Complete Examples

Redaction (Blur)

Edit (Replace with Dummy Data)

Example Responses

Redaction Response

Edit Response

Supported Documents

Security Features

Real-World Examples

Healthcare PHI Redaction

Legal Document Redaction

Insurance Document Redaction

Race Blind PII Redaction

Structured Responses

Visual Grounding

Custom Schemas

Long Context Outputs

Try our Document -> JSON API today

​Original Document

​Redacted Document

​Quick Start

​Available Domains

​Redaction Domains (Blur)

​Edit Domains (Replace)

​Information Types Redacted

​Complete Examples

​Redaction (Blur)

​Edit (Replace with Dummy Data)

​Example Responses

​Redaction Response

​Edit Response

​Supported Documents

​Security Features

​Real-World Examples

​Healthcare PHI Redaction

​Legal Document Redaction

​Insurance Document Redaction

​Race Blind PII Redaction

​Related Capabilities

Structured Responses

Visual Grounding

Custom Schemas

Long Context Outputs

​Try our Document -> JSON API today

Original Document

Redacted Document

Quick Start

Available Domains

Redaction Domains (Blur)

Edit Domains (Replace)

Information Types Redacted

Complete Examples

Redaction (Blur)

Edit (Replace with Dummy Data)

Example Responses

Redaction Response

Edit Response

Supported Documents

Security Features

Real-World Examples

Healthcare PHI Redaction

Legal Document Redaction

Insurance Document Redaction

Race Blind PII Redaction

Related Capabilities

Try our Document -> JSON API today