Swear Word Filter

Swear Filter Endpoint

The Swear Word Filter endpoint allows users to submit a text string and receive a filtered version in which offensive words have been replaced.

Endpoint

  • URL: https://api.erensko.xyz/v1/swear-filter

  • Method: POST

  • Description: This endpoint takes the original text and filters out all the bad words inside of it.

URL Parameters

Parameter
Description

replace (optional)

The optional character to replace filtered words with. (Default is *)

Headers

Key
Value

Authorization

Your own personal API key, create one by clicking here. This is required.

Body

{
  "text": "I am having a really fucking good day!"
}

Example Request

POST https://api.erensko.xyz/v1/swear-filter

Response Example

{
  "filtered": "I am having a really ****ing good day!",
  "original": "I am having a really fucking good day!",
  "filteredWords": [
    "fuck"
  ]
}

Last updated