hybrid.imgcheck

Combine our Automated Intelligent Moderation system (AIM) and our Live moderators to create a powerful low cost solution.

Photos submitted to this method, are first sent to AIM and then sent to our live moderation team based on thresholds you set.

I.E any photo that is given a 50% or greater probability by AIM can then be sent to our human moderation team for further review.

Arguments
api_key (Required)
Your API application key.
imgurl (Required)
Full url to the photo you would like moderated. (max: 65,000 characters)
customimgid (Optional)
A custom ID you wish to associate with the photo that will be carried through to the callback if your photo is sent to the live team. (max: 65,000 characters)
callback (Optional)
You may also submit a URL encoded callback on a per photo basis: read more (max: 65,000 characters)
format (Optional)
Response format: xml or json. Defaults to xml.
sandbox (Optional)
Set = 1 to bypass live moderation team (for testing).
cats (Optional)
A comma separated list of the AIM categories.

Supported Categories:

  • Nudity: Detects Full and Partial Nudity
  • WAD: Detect Weapons, Alcohol, Medical Drugs
  • Offensive: Detects Offensive Symbols, Flags, and Gestures.
  • Text: Detects if text has been added to an photo (ie Memes)
  • OCR: Returns any text characters in the image. Use in combination with PF_API_KEY parameter to check the text for profanity.
  • Faces: Detects presence of face, gender, probability of a minor, and sunglasses.
  • Celebrities: Detects Celebrities.
  • Scam: Detects presence of images associated with internet scams (ie: “catfish”) .

Example: cats=nudity,wad,offensive,celebrities,text,faces,ocr,scamthreshold_alcohol_lt or threshold_alcohol_gt (Optional)Set the threshold to pass the photo to our live team
threshold_alcohol_gt=50 would send all photos that AIM gives an alcohol probability of greater than 50 to our live team.threshold_artificialtext_lt or threshold_artificialtext_gt (Optional)Set the threshold to pass the photo to our live team
threshold_artificialtext_gt=50 would send all photos that AIM gives an artificial text probability of greater than 50 to our live team.threshold_celebrity_gt (Optional)Set the threshold to pass the photo to our live team
thresholed_celebrity_gt=50 would send all photos that AIM gives a celebrity probability of greater than 50 to our live team.threshold_drugs_lt or threshold_drugs_gt (Optional)Set the threshold to pass the photo to our live team
threshold_drugs_gt=50 would send all photos that AIM gives a drugs probability of greater than 50 to our live team.threshold_female_gt (Optional)Set the threshold to pass the photo to our live team
threshold_female_gt=50 would send all photos that AIM gives a female probability of greater than 50 to our live team.threshold_male_gt (Optional)Set the threshold to pass the photo to our live team
threshold_male_gt=50 would send all photos that AIM gives a male probability of greater than 50 to our live team.threshold_minor_gt (Optional)Set the threshold to pass the photo to our live team
threshold_minor_gt=50 would send all photos that AIM gives a minor probability of greater than 50 to our live team.threshold_naturaltext_lt or threshold_naturaltext_gt (Optional)Set the threshold to pass the photo to our live team
threshold_naturaltext_gt=50 would send all photos that AIM gives a natural text probability of greater than 50 to our live team.threshold_nudity_lt or threshold_nudity_gt (Optional)Set the threshold to pass the photo to our live team
threshold_nudity_gt=50 would send all photos that AIM gives a nudity probability of greater than 50 to our live team.threshold_nuditypartial_lt or threshold_nuditypartial_gt (Optional)Set the threshold to pass the photo to our live team
threshold_nuditypartial_gt=50 would send all photos that AIM gives a partial nudity probability of greater than 50 to our live team.threshold_nuditysafe_lt or threshold_nuditysafe_gt (Optional)Set the threshold to pass the photo to our live team
threshold_nuditysafe_gt=50 would send all photos that AIM gives a safe from nudity probability of greater than 50 to our live team.threshold_offensive_lt or threshold_offensive_gt (Optional)Set the threshold to pass the photo to our live team
threshold_offensive_gt=50 would send all photos that AIM gives a offensive symbol probability of greater than 50 to our live team.threshold_sunglasses_lt or threshold_sunglasses_gt (Optional)Set the threshold to pass the photo to our live team
threshold_sunglasses_gt=50 would send all photos that AIM gives a sunglasses probability of greater than 50 to our live team.threshold_weapon_lt or threshold_weapon_gt (Optional)Set the threshold to pass the photo to our live team
threshold_weapon_lt=50 would send all photos that AIM gives a weapons probability of less than 50 to our live team.threshold_scam_lt or threshold_scam_gt (Optional)Set the threshold to pass the photo to our live team
threshold_scam_lt=50 would send all photos that AIM gives a scam probability of less than 50 to our live team.threshold_profanity (Optional)Set = 1, to send the photo to the live team if profanity is found in the OCR text.

Example Request
https://im-api1.webpurify.com/services/rest/?api_key=[API KEY]&cats=nudity&method=webpurify.hybrid.imgcheck&threshold_nudity_lt=50&imgurl=http://urltoimage.jpg
Example Response
<?xml version="1.0" encoding="utf-8" ?> 
  <rsp stat="ok">
  <method>webpurify.hybrid.imgcheck</method>
  <format>rest</format>
  <imgid>7de93bc200ff21a26da6ddb115506e82</imgid>
  <nudity>30</nudity>
  <nuditypartial>10</nuditypartial>
  <nuditysafe>60</nuditysafe>
  <status>pending</status>
  <api_key>f3412a9614845dc17d97a5d51a6xxxx</api_key>
</rsp>
Error Codes
100: Invalid API Key
The API key passed was not valid.
101: API Key is inactive
The API key passed is inactive or has been revoked.
102: API Key was not included in request
This method requires an API Key.
103: Not a valid URL
The submitted URL is not valid.
104: Unsupported format
AIM only accepts JPEG, PNG, WEBP and multi-frame GIF Formats.
105: Unable to locate photo
The URL returned a 404 or an photo was not found.
106: Out of Requests
Out of Requests, Please refill.
107: Photo too small
Photo should be at least 50 pixels in height or width.
108: Undefined category name
A category name that we do not support was provided.
Example Error Response
{
	"rsp": {
		"@attributes": {
			"stat": "fail"
		},
		"err": {
			"@attributes": {
				"code": "108",
				"msg": "Undefined category name"
			}
		}
	}
}