POST
/ratchet/redact
const url = 'http://localhost:8000/ratchet/redact';const options = {method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:8000/ratchet/redact \ --header 'Content-Type: application/json' \ --data '{}'Show what the redactor would store for a piece of text: in the gateway’s style (RATCHET_REDACT_STYLE) or
?style=. Nothing is logged or stored. The endpoint is public, so the detector plugin, which may be an
NER model costing tens of milliseconds a call, runs only for a caller with a valid API or admin key; anyone else
gets the patterns alone (plugin_skipped).
Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Header Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
Body
object
Example generated
{}Responses
Section titled “Responses”Successful Response
Media typeapplication/json
Response Redact Preview Ratchet Redact Post
object
Example generated
{}Validation Error
Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{ "detail": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ]}