Let's get you started
Welcome to Shut Your Mouth API
Before you can start building empathetic apps, let's go through the prerequisites of using this API and get your app settled in with our service
Step 1: Greeting the natives
An account on Shut Your Mouth API gives you access to your client apps, API keys, usage details and account related information. This is the first step and that's why we called it greeting the natives
Step 2: Meeting the parents
Now that you've created an account, you will be directed to the dashboard. The next step is to create a new client app!
Step 3: Get Married to the API
That's it! You are ready to use the API and silence some online bullies! Let's learn how to call the sentiment API
The sentiments API returns a JSON payload indicating whether an input text contains explicit words, negative sentiments, offensive statements, etc. This allows developers to build empathetic apps that are less prone to cyber bully attacks from keyboard warriors. This allows you to identify negative social behavior within your application and take necessary action.
Here are some examples if what you can use this API for:
- Detect Suicidal tendencies of users
- Identify cyber bully threads
- Detect spammers
- Identify negative/aggresive online social behavior
Step 1: Grab the Telescope
You can access the sentiments endpoint by calling the following GET endpoint. This will be the endpoint that you can use to pass in a text parameter and retrieve a sentiment response.
GET - sentiment/check
Step 2: Call Houston
Go ahead and make a GET request to the URL above by passing the parameter below.
"value": "I am a mean person. You suck! I am a prick!"
Step 3: Read Houston's Response
Amazed at how simple it is? Yeah, me too Now simply retrieve this response and use these keys to your advantage. Given below are some descriptions about what each key means.
sentiment indicates the neutrality/positivity/negativity/offensiveness of the statement
contains_explicit_language indicates if any explicit language was detected within the statement
explicit_words is an array of all the detected explicit words
Soon to be added
friendly_version returns a fun twist where the explicit words are replaced with random funny words
blurred returns the filtered version of the statement where all the explicit words are replaced by a character of choice (****/XXXX/etc)
sentiment_score returns a score that represents the positivity vs negativity of a statement where the threshold can be adjusted if needed
emotions returns an array of emotions that were identified from the statement (angry/happy/sad/etc)
That's it! Your app is now amazing
That's how simple it is to use the Shut Your Mouth API! We are super excited to see what you build with it. If you have suggestons, please use the support bubble on this page to talk to us