Skip to main content
POST
/
v2
/
pii
/
redact
Redact PII
curl --request POST \
  --url https://api.orq.ai/v2/pii/redact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "language": "<string>",
  "threshold": 123
}
'
{
  "redacted_text": "<string>",
  "mappings": {}
}

Authorizations

Authorization
string
header
required

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

Body

application/json
text
string
language
string
threshold
number<double>

Response

200 - application/json

OK

redacted_text
string
mappings
object

Maps each placeholder (e.g. "<PERSON_1>") to the original value it replaced.