NEneutrinoapi
Data Tools

Bad Word Filter

Detect bad words, swear words and profanity in a given text

post/bad-word-filter

Request

  • Base URL
    https://neutrinoapi.net
  • Auth
    API key in header user-id and API key in header api-key

Request body application/x-www-form-urlencoded

contentstring required

The content to scan. This can be either a URL to load from, a file upload (multipart/form-data) or an HTML content string

censor-characterstring

The character to use to censor out the bad words found

catalogstring

Which catalog of bad words to use, we currently maintain two bad word catalogs: <br> <ul> <li>strict - the largest database of bad words which includes profanity, obscenity, sexual, rude, cuss, dirty, swear and objectionable words and phrases. This catalog is suitable for environments of all ages including educational or children's content</li> <li>obscene - like the strict catalog but does not include any mild profanities, idiomatic phrases or words which are considered formal terminology. This catalog is suitable for adult environments where certain types of bad words are considered OK</li> </ul>

Response

OK

bad-words-liststring[] required

An array of the bad words found

bad-words-totalinteger required

Total number of bad words detected

censored-contentstring required

The censored content (only set if censor-character has been set)

is-badboolean required

Does the text contain bad words

Example response

{
  "bad-words-list": [
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED",
    "REDACTED"
  ],
  "bad-words-total": 50,
  "censored-content": "",
  "is-bad": true
}

Changes

No recorded changes to this operation across all 4 revisions of this API.