Profanity Filter

Overview

Submit any string with an optional single-character mask, which defaults to an asterisk. The endpoint inspects the content against a list of profane words, swaps matches with the chosen mask character, and reports whether offensive terms appeared. Paid plans also return the total count of filtered words.

Endpoint

One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.

1
2
3
4
5
6
7

curl -X POST https://api.apiverve.com/v1/profanityfilter \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "Today is so damn hot! Why the hell would anyone go outside?",
  "mask": "*"
}'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

const res = await fetch('https://api.apiverve.com/v1/profanityfilter', {
  method: 'POST',
  headers: {
    'x-api-key': 'your_api_key_here',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "text": "Today is so damn hot! Why the hell would anyone go outside?",
  "mask": "*"
}),
});

if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);

const { data } = await res.json();
console.log(data);

1
2
3
4
5
6
7
8
9
10
11
12
13
14

import requests

res = requests.post(
    "https://api.apiverve.com/v1/profanityfilter",
    headers={"x-api-key": "your_api_key_here"},
    json={
    "text": "Today is so damn hot! Why the hell would anyone go outside?",
    "mask": "*"
},
    timeout=15,
)
res.raise_for_status()

print(res.json()["data"])

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "text": "Today is so damn hot! Why the hell would anyone go outside?",
  "mask": "*"
}`)
	req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/profanityfilter", body)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("x-api-key", "your_api_key_here")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.

Authentication

Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.

Parameters

Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them.

Response

Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.

1
2
3
4
5
6
7
8
9
10
11

{
  "status": "ok",
  "error": null,
  "data": {
    "isProfane": true,
    "filteredText": "Today is so **** hot! Why the **** would anyone go outside?",
    "mask": "*",
    "trimmed": false,
    "profaneWords": 2
  }
}

Response fields

Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.

Errors

Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.

Start from a template

A working app built on this API, ready to deploy with your own key. Vercel asks for the key when you deploy; the code is on GitHub to change first.

Content Moderator

Mask profanity in comments, reviews and chat before they go live, and count what was caught.

• Node.js
• Express

Deploy to VercelSee the template →

Use cases

Livestream Chat Overlay

Display clean real-time viewer comments on screen by replacing detected profanities with asterisks before rendering video overlays.

E-Commerce Review Sanitization

When shoppers submit product ratings, review pipelines scrub vulgar vocabulary and set the profanity flag before publishing feedback.

Classroom Discussion Boards

Educational platforms screen student forum posts to mask inappropriate terminology automatically across shared school assignment boards.

Support Ticket Sanitization

Flag hostile customer support messages automatically on submission by evaluating incoming complaint bodies for profane language.

Other ways to use Profanity Filter

Set up Profanity Filter on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.

Related

More in Text Processing: