Profanity Filter API Reference

Overview

Profanity Filter works by comparing the text against a predefined list of profanity words and replacing them with a defined mask. The profanity words are updated regularly to ensure accurate filtering.

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.

POSThttps://api.apiverve.com/v1/profanityfilter

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": "*"
}'

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);

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"])

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.

401 is the only auth verdict

A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.

Parameters

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

Parameter	Type	Description
`text`Required	string	The text to filter profanity words from
`mask`Optional	string	The mask to replace the profanity words with. Should be a Single Character (e.g., ) default

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.

Sample response

{
  "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.

Field	Type	Example	Description
`isProfane`	boolean	`true`	Whether the text contained profanity words
`filteredText`	string	`"Today is so ** hot! Why the ** would anyone go outside?"`	The text with profanity words replaced by mask characters
`mask`	string	`"*"`
`trimmed`	boolean	`false`
`profaneWords`Premium	number	`2`	Number of profanity words found and filtered

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.

Status	Meaning	What to do
`400`	Input was rejected	Read `error`; it names the parameter.
`401`	Key missing or invalid	Check the header name and the key value.
`403`	Key valid, but not permitted	A key restriction or IP allow-list; see key scoping.
`429`	Rate limited, or out of credits	Read `error` to tell them apart; see rate limits.

Use cases

Content Moderation: Use the Profanity Filter API to filter out profanity words for content moderation. Use the data to maintain a safe and respectful online environment
Chat Applications: Filter chat messages by using the Profanity Filter API to remove profanity words. Use the data to enhance user experience and prevent offensive content
Social Media Platforms: Moderate social media content by using the Profanity Filter API to filter out profanity words. Use the data to protect users from harmful language and maintain community standards
Text Analysis: Analyze text by using the Profanity Filter API to filter out profanity words. Use the data to study language patterns, sentiment analysis, and text classification
Game Moderation: Moderate in-game chat by using the Profanity Filter API to filter out profanity words. Use the data to create a positive gaming environment and prevent toxic behavior

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.

Give it to an AI agentConnect over MCP and your agent calls it as a native tool — Claude, Cursor, ChatGPT.VerveKit →Reference →

Use it in Google Sheets or ExcelA =VERVE() formula fills a column — no script, no export, recalculates in place.VerveSheets →Reference →

Profanity Filter