Skip to main content

Squillify development is paused indefinitely. Read why, and discover what this experiment achieved. Read the story

MicroSkills Reference

PII Pattern Guard

text.assert_pii_free

ProductionHeuristic (Class C)Deterministicbest-effortfastv1.0.0
File inputNo network

Overview

You pass text; we check it against a fixed set of PII pattern detectors (email, phone, credit card with Luhn, IP, IBAN) and fail when any match, so you can gate publishing, logging, or sharing. A pass means no supported detector matched — not proof the text is free of all PII (names, addresses, and context-dependent identifiers are out of scope). We return counts only, never the located values. Do not use this to mask PII — use text.mask_pii. Accepts file input via file_ref — no need to extract file content first.

You need a deterministic gate that refuses to proceed when content still contains PII, with a machine-readable path to fix it (redaction) rather than a vague warning.

Reliability

BEST_EFFORT and deterministic for a fixed input and detector set: identical input always produces the same result on this deployment. Coverage is bounded to the five declared detectors — absence of matches is not proof the text contains no PII. POLICY_PII_NOT_ALLOWED — trigger: your text matched at least one enabled detector, so the gate refuses it and reports how many matches it saw; retryable: no, the same text always fails again; next: mask the values with text.mask_pii, then call us again with the masked text. Input validation (not retryable): neither text nor file_ref; both text and file_ref; text longer than 1,048,576 characters; a detectors entry that is not a string, or a detector name outside the five we know.

Context footprint

Accepts inline text up to ~1M chars or file input via file_ref (up to 2 MB). Output is counts only. Upload files via POST /v1/files/upload before passing file_ref. A successful call costs 2 execution credits.

When to use it

Before you publish, log, export, or share text that must be PII-free. Pair with text.mask_pii to auto-remediate and retry.

When you want to mask PII rather than reject it, or when you need compliance-certified or NER-based detection.

Scope

Note
Checks text against a fixed detector set — EMAIL, PHONE, CREDIT_CARD (Luhn), IP_ADDRESS, IBAN — and fails when any matches. Returns only counts, never the located values. A pass asserts 'no supported detector matched', not absolute PII-freedom; it is a deny-by-default gate, not a compliance certification.

Non-goals

  • Does not mask or redact PII — use text.mask_pii for that (the recovery path)
  • Not exhaustive — regex-based, may miss context-dependent PII like names/addresses
  • Does not use ML/NER; not a legal-compliance certification mechanism

Properties

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

analysistext-processing

Cost & billing

Flat rate per invocation

MetercallsBillable onsuccessCost per call2 credits

File handling

Accepts file_refProduces file_refMax input1 MBMax file size1.9 MB

File limits

Constraints this skill applies to your input and generated files. The “Limited by” column shows the static source of each cap; none of these can be raised by upgrading your plan.

LimitValueLimited by
Maximum size per input file1.9 MiBSkill maximum

How we handle your data

Sensitive processing
What this means

This skill is designed to detect, mask, redact, validate, or otherwise process sensitive data.

Squillify guarantees
  • Runs inside Squillify
  • This skill runs inside Squillify.
  • Payloads are not sent to an external service by this skill.
  • Squillify does not permanently store submitted payloads.
  • Telemetry records metadata only, not submitted content.
  • Submitted payloads are not used for training.
  • Submitted payloads are not reviewed by humans.
  • Targets sensitive data
  • The response does not contain submitted content.
Your responsibility

Squillify does not determine whether submitted content is sensitive. Your application is responsible for deciding what data it is allowed to submit. Your application is responsible for securing the response.

Read the Microskill Data Handling Policy

Input schema

FieldTypeRequiredDescription
textstringNoBounded inline text source. Required unless file_ref is provided.
file_refstringNoTenant-scoped opaque text-file reference. Omit it to use the required inline text; never send both.
detectorsarrayNoBounded optional detector selector array; omit it to enable every supported PII detector. The item shape is defined by the nested schema and the array contains from 1 through 32 items.

Output schema

FieldTypeRequiredDescription
piiFreebooleanYesAlways true for a returned successful assertion.
detectionCountintegerYesDetected PII match count, always zero on success.
countsByTypeobjectYesPurpose-bound detector-type count map, empty on success. It contains from 0 through 64 detector-name count properties.

API contract

POST /v1/execute
curl
curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"text.assert_pii_free","input":{"text":"The quarterly report is ready."}}'
Integrations
TypeScript SDK
import { Squillify } from "@squillify/sdk";

const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });

const { output } = await sq.execute("text.assert_pii_free", {"text":"The quarterly report is ready for review."});

Errors

CodeHTTPRetryableDescription
VALIDATION_ERROR400NoThe request payload failed schema validation.
UNAUTHORIZED401NoMissing or invalid API key.
SKILL_NOT_ACCESSIBLE403NoThe API key is not granted access to this skill.
SKILL_NOT_AVAILABLE_FOR_PLAN403NoThis skill is not included in your current plan.
PLAN_ELIGIBILITY_UNAVAILABLE503YesPlan eligibility could not be decided. Retry after backoff.
SKILL_NOT_FOUND404NoThe requested skill or version does not exist.
TENANT_RATE_LIMITED429YesRequest rate limit exceeded. Retry after backoff.
QUOTA_EXCEEDED429YesPlan quota exhausted. Retryable once the quota period resets.
EXECUTION_TIMEOUT504YesExecution exceeded the allowed time budget.
POLICY_PII_NOT_ALLOWED403NoThe operation is forbidden by policy or permissions.

Other limits

LimitValue
Recommended inline bytes32 KiB

Limitations

  • Does not mask or redact PII — use text.mask_pii for that (the recovery path)
  • Not exhaustive — regex-based, may miss context-dependent PII like names/addresses
  • Does not use ML/NER; not a legal-compliance certification mechanism
  • Removing/masking PII — use text.mask_pii
  • Compliance-grade or NER-based PII detection
  • Detecting names/addresses without recognizable patterns

How to call

POST /v1/execute (requires authentication)

Request bodyjson
{
  "skillKey": "text.assert_pii_free",
  "input": {
    "text": "The quarterly report is ready for review."
  }
}

Examples

Clean text passes

Inputjson
{
  "text": "The quarterly report is ready for review."
}
Expected outputjson
{
  "countsByType": {},
  "piiFree": true,
  "detectionCount": 0
}

Re-check masked output before publishing

Inputjson
{
  "detectors": [
    "EMAIL",
    "PHONE"
  ],
  "text": "Contact [EMAIL] for details, or ring [PHONE]."
}
Expected outputjson
{
  "countsByType": {},
  "piiFree": true,
  "detectionCount": 0
}
Tip
The same text before masking fails with POLICY_PII_NOT_ALLOWED and no success body — mask it, then re-check like this to prove the gate now passes
  • Gate outbound content on 'no PII present' before publishing or third-party sharing
  • Pre-flight check in a pipeline that must not log identifiable data
  • Assert redaction succeeded by re-checking masked output

Avoid for

  • Removing/masking PII — use text.mask_pii
  • Compliance-grade or NER-based PII detection
  • Detecting names/addresses without recognizable patterns

Composable with

Safety & privacy

  • Runs without calling any external service.
  • Your payloads are never stored permanently.
  • Telemetry captures metadata only — never your payload contents.
  • We never train models on your payloads.
  • No human reviews your payloads.

Tags

securitytext