You can access the PII Masking programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in API & Integrations in Apify Console.

Python

JavaScript

CLI

OpenAPI

HTTP

MCP

# Set API token
$API_TOKEN=<YOUR_API_TOKEN>

# Prepare Actor input
$cat > input.json << 'EOF'
<{
<  "text": [
<    "Hello John Matthews. Call me at 555-0100."
<  ],
<  "fieldPaths": [
<    "text"
<  ],
<  "hideit": {
<    "outputMode": "MARKER"
<  },
<  "split": {
<    "enabled": true
<  },
<  "limits": {
<    "maxInputChars": 10000
<  },
<  "proxy": {
<    "useApifyProxy": true
<  }
<}
<EOF

# Run the Actor using an HTTP API
# See the full API reference at https://docs.apify.com/api/v2
$curl "https://api.apify.com/v2/actors/canadesk~pii-masking/runs?token=$API_TOKEN" \
<  -X POST \
<  -d @input.json \
<  -H 'Content-Type: application/json'

PII Masking API

Below, you can find a list of relevant HTTP API endpoints for calling the PII Masking Actor. For this, you’ll need an Apify account. Replace <YOUR_API_TOKEN> in the URLs with your Apify API token, which you can find under API & Integrations in Apify Console. For details, see the API reference.

Run Actor

POST
https://api.apify.com/v2/actors/canadesk~pii-masking/runs?token=<YOUR_API_TOKEN>

Note: By adding the method=POST query parameter, this API endpoint can be called using a GET request and thus used in third-party webhooks. Please refer to our Run Actor API documentation.

Run Actor synchronously and get dataset items

POST
https://api.apify.com/v2/actors/canadesk~pii-masking/run-sync-get-dataset-items?token=<YOUR_API_TOKEN>

Note: This endpoint supports both POST and GET request methods. However, only the POST method allows you to pass input data. For more information, please refer to our Run Actor synchronously and get dataset items API documentation.

Get Actor

GET
https://api.apify.com/v2/actors/canadesk~pii-masking?token=<YOUR_API_TOKEN>

For more information, please refer to our Get Actor API documentation.

Actors can be used to scrape web pages, extract data, or automate browser tasks. Use the PII Masking API programmatically via the Apify API.

You can choose from:

PII Masking API in Python

PII Masking API in JavaScript

PII Masking API through CLI

PII Masking OpenAPI definition

You can start PII Masking with the Apify API by sending an HTTP POST request to the Run Actorendpoint. An Actor’s input and its content type can be passed as a payload of the POST request, and additional options can be specified using URL query parameters. The PII Masking is identified within the API by its ID, which is the creator’s username and the name of the Actor.

When the PII Masking run finishes you can list the data from its default dataset(storage) via the API or you can preview the data directly on Apify Console.