Redact personal data
POST/redact
Finds personal data in text (names, email addresses, phone numbers, postal addresses, account numbers and more) and masks it, in the privacy filter's own format, with privacy-filter (alias openai/privacy-filter). model is optional. At most 256 inputs and a body of 192 KiB (196,608 bytes) per request. The text sent is processed in memory only: it is never written to disk or logs and never used for training.
The request is billed on an estimate: ceil(characters of all inputs / 4) tokens, with characters counted as Unicode code points. The answer carries no usage. Only Serenity Edge API keys can use this route. See the Embeddings, rerank and redaction guide.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 413
- 429
- 500
- 503
For a string in inputs, one result: the text with each item found masked, and the items found. For an array, an array of results in input order.
The request was refused: a body that is not a JSON object, a missing or invalid inputs, placeholders, categories or model, more than 256 inputs, a model served on another route, or a request the model server could not process (The model server rejected the request. Check the input sizes and parameters.). param names the field at fault when there is one.
Missing or invalid API key.
The key is valid but cannot use this route: only Serenity Edge API keys can. Any other key, such as a key from a Serenity Star account, gets permission_denied with a message that names the route's API (embeddings, rerank or redact).
The model id is unknown, or it is a chat or decision model, which cannot be used on this route (model_not_found).
The request body is larger than this route accepts (192 KiB, 196,608 bytes, request_too_large).
Rate limit exceeded, or the service is temporarily at capacity for this model. Wait for the number of seconds in the Retry-After header before retrying.
Response Headers
Seconds to wait before retrying.
Unexpected server error: the model service returned an unexpected response (upstream_error), the request got no answer within 600 seconds (timeout), or an error in the gateway. Retry with backoff.
The model service is temporarily unavailable (upstream_unavailable). Retry later and check the status page at https://status.serenityedge.ai.