This is a current list of available parameters which can be used in the request query string:
Parameter | Required | Description |
---|---|---|
text | Required | Input text to be processed. |
add | Optional | A comma separated list of words to be added to the profanity list. Accepts letters, numbers, underscores (_) and commas (,). Accepts up to 10 words (or 200 maximum characters in length). The PurgoMalum filter is case-insensitive, so the case of your entry is not important. |
fill_text | Optional | Text used to replace any words matching the profanity list. Accepts letters, numbers, underscores (_) tildes (~), exclamation points (!), dashes/hyphens (-), equal signs (=), pipes ( |
fill_char | Optional | Single character used to replace any words matching the profanity list. Fills designated character to length of word replaced. Accepts underscore (_) tilde (~), dash/hyphen (-), equal sign (=), pipe ( |
GET: `check?text=What the fuck are you doing?`
RESPONSE: true
GET: `replace?text=What the fuck are you doing?`
RESPONSE:
{
"result": "What the f*ck are you doing?"
}
GET: `advance?text=How about you?&add=about&fill_char=_`
RESPONSE:
{
"result": "How _____ you?"
}