agentutility(7)$ man detect-pii
/detect-pii
NAME
detect-pii — detects pii in text: emails, phones, ssns, credit cards, addresses, names, ips, and api tokens
SYNOPSIS
POST https://x402.agentutility.ai/detect-pii
Content-Type: application/json
X-PAYMENT: <signed-transferWithAuthorization>
{ ... }↳ first call →
402 Payment Required. Sign USDCtransferWithAuthorization, retry with theX-PAYMENT header.DESCRIPTION
Detects PII in text: emails, phones, SSNs, credit cards, addresses, names, IPs, and API tokens. Returns matches + risk_level, with optional redaction using [TYPE] tokens. Use it as a PII detector, personal data scanner, data leak scanner, or privacy redaction API.
INPUT — request schema
| property | type | description | req? |
|---|---|---|---|
| text | string | Text to scan for PII. Max 25,000 chars. | required |
| redact | boolean | Optional. If true, also returns redacted_text with matches replaced by [TYPE] tokens. Default false. | optional |
OUTPUT — response shape
| field | type | description |
|---|---|---|
| matches | array | Array of detected PII items, each with the matched value, type label, and character offset in the text. |
| match_count | number | Total number of PII matches found across all types. |
| pii_density | number | Ratio of PII characters to total input characters, roughly 0 to 1. |
| risk_level | string | Overall risk bucket such as none, low, medium, or high based on match types and density. |
| redacted_text | string | Input text with each match replaced by a [TYPE] token like [EMAIL] or [SSN] when redaction is requested. |
| input_chars | number | Character length of the submitted text. |
| model | string | Identifier of the detection model or ruleset version used for this scan. |
EXAMPLES — two ways to call
EXAMPLE 1 · curl
curl -X POST https://x402.agentutility.ai/detect-pii \
-H 'Content-Type: application/json' \
-d '{ }'first response =
402 Payment Required with payment requirements; sign + retry with X-PAYMENT.EXAMPLE 2 · mcp
# Install the MCP package for this endpoint's cluster npx -y @agentutility/mcp-<cluster> # Required: EVM private key with USDC on Base export X402_PRIVATE_KEY=0x... # Then call the detect-pii tool from your MCP-aware agent.
MCP server handles payment automatically — your coding agent just calls the tool by name.
METADATA
- tags
- piiprivacyredactcompliancesecurity
- env
- VENICE_API_KEY
- methods
- POST
- cluster
- wordmint
- price
- $0.02 USDC per call
ADJACENT — other endpoints in wordmint
| endpoint | description | price |
|---|---|---|
| alt-text-generator | Turns a public image URL into ready-to-use text: concise alt text for screen readers, a natural-language description, OCR text pulled fro… | $0.02 |
| classify | Sort text into categories you define on the spot, no training run required. | $0.02 |
| classify-text | Sorts a piece of text into categories you define on the fly, no training or fixed label set required. | $0.02 |
| describe-image | Describes images with a vision LLM across five modes: describe, alt_text (accessibility, <=125 chars), OCR (extract visible text), tags (… | $0.02 |
| email-draft | Writes emails with AI: subject, body, salutation, and sign-off. | $0.02 |
| extract | Pull structured entities out of raw text instead of hand-parsing it yourself. | $0.02 |
| image-describe | Get a vision model's read on an image: a description, alt text, extracted text, tags, or a caption. | $0.02 |
| image-description | Takes a public image URL and returns an AI vision description, alt text, OCR text, tags, or caption depending on mode. | $0.02 |
SEE ALSO