Skip to content

Developer Quick Start

This guide provides a quick start for developers integrating with Philterd Data Services. We'll walk through the process of creating a custom redaction policy, uploading a document for redaction, and downloading the result using both curl and Python.

Prerequisites

Before you begin, ensure you have:

  • A Philterd Data Services account.
  • An API Key.
  • The base URL for the API: https://api.data.philterd.ai

Step 1: Create a Redaction Policy

A redaction policy defines what information should be identified and how it should be handled. While you can use the default policy, creating a custom one allows for more control.

The Policy (JSON)

Save the following as my-policy.json:

{
  "version": "1.0",
  "name": "my-custom-policy",
  "filters": {
    "PERSON": [
      {
        "strategy": "REDACT"
      }
    ],
    "EMAIL_ADDRESS": [
      {
        "strategy": "MASK"
      }
    ]
  }
}

Create the Policy via API

Using curl

curl -X POST "https://api.data.philterd.ai/api/policy/my-custom-policy" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d @my-policy.json

Using Python

import requests

api_key = "YOUR_API_KEY"
policy_name = "my-custom-policy"
url = f"https://api.data.philterd.ai/api/policy/{policy_name}"

with open("my-policy.json", "r") as f:
    policy_json = f.read()

headers = {
    "Authorization": f"Bearer {api_key}",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers, data=policy_json)
print(response.json())

Step 2: Upload a Document for Redaction

Now, let's upload a document (e.g., a PDF or .docx file) to be redacted using the policy we just created.

Using curl

curl -X POST "https://api.data.philterd.ai/api/redact/documents?policy=my-custom-policy" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/pdf" \
     --data-binary @sample_document.pdf

Using Python

import requests

api_key = "YOUR_API_KEY"
policy_name = "my-custom-policy"
url = f"https://api.data.philterd.ai/api/redact/documents?policy={policy_name}"

headers = {
    "Authorization": f"Bearer {api_key}",
    "Content-Type": "application/pdf"
}

with open("sample_document.pdf", "rb") as f:
    response = requests.post(url, headers=headers, data=f)

result = response.json()
document_id = result["documentId"]
print(f"Document uploaded. Document ID: {document_id}")

The response will contain a documentId. Save this ID, as you'll need it to download the redacted file.

Step 3: Download the Redacted Document

Once processing is complete (usually within seconds), you can download the redacted version using the document ID.

Using curl

curl -X GET "https://api.data.philterd.ai/api/redact/documents/YOUR_DOCUMENT_ID" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     --output redacted_document.pdf

Using Python

import requests

api_key = "YOUR_API_KEY"
document_id = "YOUR_DOCUMENT_ID"
url = f"https://api.data.philterd.ai/api/redact/documents/{document_id}"

headers = {
    "Authorization": f"Bearer {api_key}"
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    with open("redacted_document.pdf", "wb") as f:
        f.write(response.content)
    print("Redacted document downloaded successfully.")
else:
    print(f"Error: {response.status_code}")

Next Steps