{"info":{"_postman_id":"1ebce58a-168c-463f-9103-3340b0ab522a","name":"Mod-Gurad API Documentation","description":"

RESPONSES FOR VARIOUS REQUESTS -

\n
An Unauthorized request, results in a HTTP 401 status code
\n

\n
A proper request might result in HTTP 429 status code if API rate limit is reached
\n

Request structure (multipart/form-data) -

\n
NOTE: Remember requests must be of multipart/form-data
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Description
strategy (required)	This field accepts either 1 or 2 as its value , 1 means API strategy , 2 means API + Publisher/Consumer strategy
image_file	This field accepts image file , so provide the image file and make sure that you don't provide the image_link along with this as well and I have set the size limit of image to be less than 5 MB , you can increase/decrease that as well , in the multer.js file located in the middleware folder.
image_moderation	This field accepts nudity,gore,wad,offensive as value, you can only choose from these moderation models.
image_link	This field accepts complete URL/URI of the image , including the http or https , and make sure that you don't provide the image_file along with this as well
isProfane	This field accepts text and returns whether the text was profane or not!
filter_profanity	This field accepts text with or without profanity/bad-words and returns the profanity/bad-words filtered text
isMalicious	This field accepts URL of a website and returns whether it is malicious or not!
isSpam[content]	This field accepts text and detects whether the text is spam or not, for detecting it also needs ip address and useragent of the sender, perfect use-case : comments on a post, sending the ip address & useragent of the commenter
isSpam[ip]	This field accepts ip address of the text sender, needed to help detect whether the text is spam or not
isSpam[useragent]	This field accepts the browsers useragent of the text sender, needed to help detect whether the text is spam or not
isSpam[name]	This field accepts name of the spam text sender , for more accruacy , but not compulsory
isSpam[email]	This field accepts email of the spam text sender , for more accruacy , but not compulsory
isSpamEmail	This field accepts any email and determines whether that email is marked as spam or not
metadata	This is just the reference info that client can provide along with the request ,it can be of any type and this will be returned back with the response and this will not be stored by the server , use-case : if you are using our API + publisher/consumer strategy , you might need to know info of some request later down the road, so for that you can add some metadata on each and every request, which will be propagated through and will be available at the consumer end

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14691472","collectionId":"1ebce58a-168c-463f-9103-3340b0ab522a","publishedId":"UV5TEyxx","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-10-12T13:48:10.000Z"},"item":[{"name":"Api or Api+Pub/Con strategy","id":"c2cc9a32-aef4-47df-af9c-d3ad2c00b61f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"AUTH_KEY","value":"THIS_IS_VERIFIED_REQUEST","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"strategy","value":"2","type":"text"},{"key":"image_file","type":"file","src":"/C:/Users/Swastik gowda/Pictures/Saved Pictures/nsfw.jpg","disabled":true},{"key":"image_moderation","value":"nudity","type":"text","disabled":true},{"key":"image_link","value":"https://i.natgeofe.com/n/46b07b5e-1264-42e1-ae4b-8a021226e2d0/domestic-cat_thumb_square.jpg","type":"text","disabled":true},{"key":"isMalicious","value":"https://www.nighorizon.com","type":"text"},{"key":"isProfane","value":"wassup mate ?","type":"text"},{"key":"filter_profanity","value":"what the hell mate ?","type":"text","disabled":true},{"key":"isSpam[ip]","value":"123.123.1.1","type":"text","disabled":true},{"key":"isSpam[useragent]","value":"CommentorsAgent 1.0 WebKit","type":"text","disabled":true},{"key":"isSpam[content]","value":"check out my blog","type":"text","disabled":true},{"key":"isSpam[email]","value":"not.a.spammer@gmail.com","type":"text","disabled":true},{"key":"isSpam[name]","value":"john doe","type":"text","disabled":true},{"key":"isSpamEmail","value":"jexihot163@specialistblog.com","type":"text","disabled":true},{"key":"metadata","value":"123456","type":"text"}]},"url":"localhost:3000/modGuard","description":"

Responses for content moderation requests-

\n
A successful moderation request, results in a HTTP 200 status code
\n

\n
A bad moderation request, results in a HTTP 400 status code
\n

\n
NOTE: Must provide the auth_key in the header of each and every request! \nMake sure you change the default auth_key in the .env file.
\n

\n
Below is an example request -
\n

\n","urlObject":{"port":"3000","path":["modGuard"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"c2cc9a32-aef4-47df-af9c-d3ad2c00b61f"},{"name":"Publisher Consumer","id":"0766067f-7f8e-4334-96a8-894e41e1cfb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"AUTH_KEY","value":"THIS_IS_VERIFIED_REQUEST","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"strategy","value":"2","type":"text"},{"key":"image_file","type":"file","src":"/C:/Users/Swastik gowda/Pictures/Saved Pictures/abstract1.jpg","disabled":true},{"key":"image_moderation","value":"nudity,wad","type":"text"},{"key":"image_link","value":"https://cdn.britannica.com/q:60/91/181391-050-1DA18304/cat-toes-paw-number-paws-tiger-tabby.jpg","type":"text"},{"key":"isProfane","value":"what the hell mate ?","type":"text"},{"key":"filter_profanity","value":"what the hell mate ?","type":"text"},{"key":"isMalicious","value":"http://www.amazon.com","type":"text"},{"key":"isSpam[ip]","value":"115.13.94.65","type":"text"},{"key":"isSpam[useragent]","value":"CommentorsAgent 1.0 WebKit","type":"text"},{"key":"isSpam[content]","value":"Very nice blog! Check out my blog!","type":"text"},{"key":"isSpam[email]","value":"not.a.spammer@gmail.com","type":"text"},{"key":"isSpam[name]","value":"john doe","type":"text"},{"key":"isSpamEmail","value":"swastikdragon@gmail.com","type":"text"},{"key":"metadata","value":"swastik","type":"text","disabled":true}]},"url":"localhost:3000/modGuard/pubcon","description":"

Responses for content moderation requests-

\n
A successful moderation request, results in a HTTP 200 status code
\n

\n
A bad moderation request, results in a HTTP 400 status code
\n

\n
NOTE: Must provide the auth_key in the header of each and every request! \nMake sure you change the default auth_key in the .env file.
\n

\n
Below is an example request -
\n

\n","urlObject":{"port":"3000","path":["modGuard","pubcon"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"0766067f-7f8e-4334-96a8-894e41e1cfb8"}]}