Profanity Filter API

Frequently Asked Questions

• Can I use the Profanity Filter API for commercial purposes?

  Yes, but you must have a premium subscription. Commercial use of the Profanity Filter API is not permitted on the free tier. See our pricing page to choose a plan that fits your needs.

• How do I get an API key and start using the Profanity Filter API?

  Sign up for a free account to instantly get your API key, then pass it in the X-Api-Key header on every request. The documentation above includes ready-to-run examples in cURL, Python, JavaScript, Node.js, and more.

• What happens if I exceed my quota for the month?

  Your API requests will simply be denied once you hit your monthly quota — you will never be charged more than the plan you signed up for. To increase your quota, you can upgrade your plan any time on our pricing page.

• What happens if a request to the Profanity Filter API fails?

  The API responds with a standard HTTP status code and a JSON error message describing the problem. See our error codes reference for the full list of codes and how to resolve each one, or contact support if you need help.

• What does the Profanity Filter response include and how is text censored?

  The /v1/profanityfilter GET endpoint returns a JSON object with original (your input text), censored (the same text with bad words replaced by asterisks), and has_profanity (a boolean that is true or false). If the request is unsuccessful you will receive an error instead, as described in our error codes.

• Is there a limit on how much text I can submit?

  Yes, the required text query parameter accepts a maximum of 1000 characters per request, so longer documents must be split into chunks before sending. See pricing for the request volume allowed on each plan.

• Can I just check whether text contains profanity without censoring it?

  Every call returns the has_profanity boolean, so you can use that flag alone for moderation gating and ignore the censored output if you do not need the masked text. To also analyze the tone or intent of the same content, pair it with the Sentiment API.

• How can I clean up user text before filtering profanity?

  The endpoint filters whatever text you pass, so pre-processing user input can improve results, for example correcting typos with the Spell Check API or detecting the input language first with the Text Language API.