Skip to main content
POST
Detect PII

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The workspace is resolved from the API key, never sent in the body.

text
string

Text to analyse.

language
string

BCP-47 language code. Unset means auto-detect.

threshold
number<double>

Global minimum recognizer score (0.0-1.0). Unset uses the provider default.

include_entities
boolean

When true, the response includes a per-type entity breakdown.

Response

200 - application/json

OK

has_pii
boolean
entities
object

Per-entity-type counts. Populated only when include_entities was set.