API Provider

APISumo
APISumo

Developer links

Bad Words API
Bad Words API

Detects bad words, swear words by performing profanity check in a given text.

An advanced profanity filter based on English phonetics (how stuff sounds). It will help you identify bad/swear words in a given text. It will also apply a mask on the detected words and censor it.

It is an intelligent filter btw. It will predict of any misuses and will also detect social media acronyms.

For example, fck will get caught as it should, but frck will not. Shat or shet will be caught as it should, but not shot.

  • Tells you what swears and where they are used in a message
  • Very resistant to filter bypassing attempts. Deviations to words will be caught and reported.
  • Words with special characters can get caught.
  • Words with certain deviations will get caught.

Currently works with English only. As well as detection and extraction of bad words you can also use this API to censor bad words from the supplied text.

How secure is this service?

Prompt API is a legal entity in European Union and regulated by its laws. We never store any sensitive information on our servers and fully respect your privacy.

Is it free?

Bad Words API is a paid service but we have a free plan that will be more than enough for you to test its functionalities and see if it works for your needs.

How does Prompt API's pricing work?

Our subscriptions are tiered. We offer a monthly subscription scheme and you decide which tier works for you the best. No strings attached.

Can I cancel/upgrade/downgrade at any time?

Sure you can. You can cancel your subscription or upgrade/downgrade yourself, anytime without any restrictions.

Tells you what swears and where they are used in a message
Deviations to words will be caught and reported.
Words with special characters can get caught
Very resistant to filter bypassing attempts

Ready to try it out?

We offer a free plan. No credit cards required!


or see documentation

Bad Words API Reference

This API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Just Getting Started?

Check out our development quickstart guide.

Authentication

Bad Words API uses API keys to authenticate requests. You can view and manage your API keys in the Accounts page.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

All requests made to the API must hold a custom HTTP header named "apikey". Implementation differs with each programming language. Below are some samples.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Endpoints

Detect bad words, swear words and profanity in a given text.

Parameters

body (required)

Text to perform profanity check

Location: Body, Data Type: string

censor_character (optional)

The censor character to apply. Defaults to *

Location: Query, Data Type: string

** A word enclosed with curly brackets "{ }" in the code means that it is a parameter and it should be replaced with your own values when executing. (also overwriting the curly brackets).
Returns

Below is a sample response from the endpoint


If you wish to play around interactively with real values and run code, see...

Rate Limiting

Each subscription has its own rate limit. When you become a member, you start by choosing a rate limit that suits your usage needs. Do not worry; You can upgrade or downgrade your plan at any time. For this reason, instead of starting with a larger plan that you do not need, we can offer you to upgrade your plan after you start with "free" or "gold plan" options and start using the API.

When you reach a rate limit (both daily and monthly), the service will stop responding and returning the HTTP 429 response status code (Too many requests) for each request with the following JSON string body text.

{
  "message": "API rate limit exceeded"
}
A reminder email will be sent to you when your API usage reaches both 80% and 90%, so that you can take immediate actions such as upgrading your plan in order to prevent your application using the API from being interrupted.

You can also programmatically check your rate limit yourself. As a result of each request made to the Prompt API, the following 4 fields provide you with all the necessary information within the HTTP Headers.

x-ratelimit-limit-month: Request limit per month
x-ratelimit-remaining-month: Request limit remaining this month
x-ratelimit-limit-day: Request limit per day
x-ratelimit-remaining-day: Request limit remaining today

You can contact our support unit if you need any assistance with your application regarding to handle the returned result by looking at the header information.

Error Codes

Prompt API uses standard HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate a clientside error, which means that failed given the information provided (e.g., a missing parameter, unauthorized access etc.). Codes in the 5xx range indicate an error with Prompt API's servers (normally this should'nt happen at all).

If the response code is not 200, it means the operation failed somehow and you may need to take an action accordingly. You can check the response (which will be in JSON format) for a field called 'message' that briefly explains the error reported.

Status Code Explanation
400 - Bad Request The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized No valid API key provided.
404 - Not Found The requested resource doesn't exist.
429 - Too many requests API request limit exceeded. See section Rate Limiting for more info.
5xx - Server Error We have failed to process your request. (You can contact us anytime)

You can always contact for support and ask for more assistance. We'll be glad to assist you with building your product.

See Also

View All