Take identifying detail out of text

Returns the text with people replaced by plausible stand-ins, and the map needed to reverse it. Send the returned text to your model; send the model's reply to /restore with the same map.

post/redact

Request

  • Base URL: https://secureai.one/v1
  • URL: https://secureai.one/v1/redact
  • Auth: HTTP bearer

Request body

textstring required

The text to redact.

mapobject

A map from a previous call, so the same person keeps the same stand-in across turns.

allowstring[]

Terms to send as written — a shared mailbox, a product name a detector mistakes for a person.

strictboolean

Refuse the request rather than proceed when the name check cannot decide. Off by default: the structured stages have already run, and refusing costs somebody their answer to protect a name that may not be there. Turn it on when the input is records rather than one person's messages.

organisationsboolean

Hide the names of companies and other private organisations too, each behind an invented company name. Off by default: a company is usually what the question is about. Public bodies (courts, ministries, EU institutions) stay as written either way.

Response

The redacted text and its map

object'redaction'
textstring

The text with stand-ins in place. Send this to your model.

mapobject

Stand-in to real value. Returned here and stored nowhere — keep it for the life of the conversation or that answer cannot be restored.

redactedinteger

How many values were replaced.

names_decidedboolean

Whether the name check reached a decision. False means it could not run, not that no names were found.

Changes

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