Profanity Filter API

About the Profanity Filter API

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.

What people use it for

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.

Ways to call it

One endpoint, many ways in — REST with JSON, XML, YAML and CSV, plus GraphQL and an MCP interface for AI agents.

JSON

Default REST response

XML

Markup format

YAML

Human-readable

CSV

Tabular export

Beta

GraphQL

Query language

New

MCP

For AI agents

Request parameters — POST /v1/profanityfilter

Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them. Anything not listed here is dropped rather than passed through.

Required

Optional

1
2
3
4

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

Authentication

Send your key in the x-api-key header. That is the only auth step — no token exchange, and no per-endpoint scope to configure.

Response — POST /v1/profanityfilter

Every APIVerve endpoint returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape.

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.

Response headers

Every response carries your balance, so your own code always knows where it stands without polling anything. All four are exposed to browsers through CORS.

Errors

Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change.

What a call costs — 2 credits per call

Credits are shared across every APIVerve API — one balance, one key, one bill. Failed requests never count against it, so a rejected input costs nothing.

Calls are what the credits buy at this API's rate — spend them here, on any of the other APIs, or across both. Nothing is reserved per endpoint.

Zero-code embed — one snippet, no backend

Drop an interactive Profanity Filter form onto any page. The widget calls the API for you, so no key ever appears in your markup and there is nothing to deploy.

Changelog — Profanity Filter API

Every change to this endpoint, newest first. Breaking changes ship as a new version and the previous one keeps serving — response fields are added, never removed or retyped in place, so an integration written against v1 keeps working.

Currently v1