{
"isProfane": true,
"count": 1,
"matches": [
{
"word": "sh1t",
"index": 22
}
],
"censored": "What the f*** is this ****",
"languages": [
"en"
],
"attribution": "Word lists: List of Dirty, Naughty, Obscene, and Otherwise Bad Words (Shutterstock), CC BY 4.0"
}
curl --location --request GET 'https://zylalabs.com/api/14226/profanity+filter+api+-+25+languages/35306/check+and+censor+text?text=What the f*** is this sh1t&lang=en&fill=*&leet=true' --header 'Authorization: Bearer YOUR_API_KEY'
{
"isProfane": true,
"count": 1,
"matches": [
{
"word": "piece of sh1t",
"index": 17
}
],
"censored": "You are a stupid ***** ** ****",
"languages": [
"en"
],
"attribution": "Word lists: List of Dirty, Naughty, Obscene, and Otherwise Bad Words (Shutterstock), CC BY 4.0"
}
curl --location --request POST 'https://zylalabs.com/api/14226/profanity+filter+api+-+25+languages/35307/check+and+censor+text+post+text+body?lang=en&fill=*&leet=true' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw 'You are a stupid piece of sh1t'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Profanity Filter API - 25 Languages simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
Each endpoint returns a JSON object containing information about detected profanity in the input text. This includes whether the text is profane, the count of profane words, the specific matches found, the censored version of the text, and the languages detected.
Key fields in the response include "isProfane" (boolean), "count" (number of profane words), "matches" (array of detected words with their indices), "censored" (censored text), "languages" (detected languages), and "attribution" (source of word lists).
The endpoints accept text input as a query parameter for GET requests or in the body for POST requests. Users can customize their requests by including custom blocked words and an allow-list to manage false positives.
The response data is structured as a JSON object. It includes a boolean indicating profanity detection, a count of matches, an array of matched words with their positions, the censored text, and the languages identified, making it easy to parse and utilize.
The profanity detection relies on curated word lists, specifically the "List of Dirty, Naughty, Obscene, and Otherwise Bad Words" from Shutterstock, which is licensed under CC BY 4.0, ensuring a reliable source for profanity detection.
Typical use cases include moderating user-generated content on forums, chat applications, and social media platforms, ensuring compliance with community guidelines, and enhancing user experience by filtering offensive language.
Users can utilize the returned data by checking the "isProfane" field to determine if action is needed. The "censored" field can be used to display a sanitized version of the text, while "matches" can help identify specific words for further moderation or user feedback.
If the response indicates "isProfane" is false or the "matches" array is empty, it means no profanity was detected. Users can handle this by allowing the text to be displayed as is, or by implementing additional checks if needed for context-specific filtering.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund