Detect and mask PII in a document

post/v1/ai/guardrails/pii-detection

Request

Base URL
https://api.intura.co (the document declares no server; this is the origin it was published from)
Auth
none declared

Request body

textstring required

The document to scan. Bounded by the module's MAX_CHARS; anything past the limit is neither scanned nor returned, so a masked_text shorter than what was submitted means the tail was dropped.

thresholdsobject nullable

Move the cut for this one call: min_score (default 0.5), the lowest score a model span may have and still be masked. Pattern hits are never filtered by it. The console's playground is where to find the value that suits your documents; this field is where to put it.

maskboolean

Return the masked document. Set false to detect only — the span list still comes back, result.masked_text does not. Use it when you need to know whether PII is present without moving the document.

Example request

{
  "text": "Halo, saya Budi Santoso, NIK 3174012345678901, HP 081234567890.",
  "thresholds": {
    "min_score": 0.35
  }
}

Response

Successful Response

statusstring

Always success on a 2xx

codeinteger

Mirrors the HTTP status code

Changes

No recorded changes to this operation across all 1 revision of this API.