aim.imgcheck
Version 2.0 | 1.0
Use this method to submit a photo to the WebPurify Automated Intelligent Moderation (AIM) Service. A percentage probability (0.00 – 100) that the submitted photo contains the categories you choose will be returned in real-time. Images that are at least 300px by 300px will return the most accurate results, however the minimize image size accepted is 50px by 50px.
Endpoint
https://im-api1.webpurify.com/v2/services/rest/
Arguments
- api_key (Required)
- Your API key.
- imgurl (Required)
- Full url to the photo you would like moderated.
- format (Optional)
- Response format: xml or json. Defaults to xml.
- cats (Optional)
- A comma separated list of the AIM categories. Defaults to Porn
- pf_api_key (Optional)
- Link a WebPurify Profanity Filter to your AIM request to check OCRT text for profanity .
- 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)
Supported Categories
-
- porn: Detects images that contain commercial pornography, amateur pornography, sexting selfies, nudity, sex acts, greyscale pornographic images, sexually explicit cartoons and manga.
-
- extremism: Detects images containing extremism militants, beheadings, executions, propaganda, acts of extremism, flags and insignia.
-
- csam: Detects Child Sexual Abuse Material
-
- weapons: Detects images containing handheld weapons such as rifles, machine guns, hand guns, knives, swords, grenade launchers and people holding firearms.
-
- gore: Detects images containing graphic violence, bloody wounds, accident victims,
beatings, mutilation, decapitation and other images that contain blood and guts.
- gore: Detects images containing graphic violence, bloody wounds, accident victims,
-
- drugs: Detects images containing illegal drugs, drug use, drug paraphernalia, plants and symbols relating to drugs.
-
- gestures: Images containing middle finger hand gestures.
-
- underwear: Detects images containing people wearing swimsuit, bikinis, underwear, bras,
panties and lingerie.
- underwear: Detects images containing people wearing swimsuit, bikinis, underwear, bras,
-
- alcohol: Alcoholic brands and beverages, people drinking alcohol, frat parties, keg stands,
bars and nightclubs, party aftermaths, shots, beer pong, kegs, and plastic cups
associated with drinking.
- alcohol: Alcoholic brands and beverages, people drinking alcohol, frat parties, keg stands,
-
- gambling: Images containing gambling imagery, casinos, lottery, online betting, slots, poker and games of chance.
-
- genai: Detects AI generated images.
-
- ID: Detects images containing pictures of passports, driver licenses, photo ids, social
security cards, debit and credit cards.
- ID: Detects images containing pictures of passports, driver licenses, photo ids, social
-
- documents: The documents category is designed to identify images containing pictures of documents, invoices, financial statements, spreadsheets, pages of text and blocks of small font text.
-
- qrbarcodes: Detects images containing QR codes and barcodes.
-
- currency: Detects images containing money, including various international currencies.
-
- face: Identifies if the image contains one or more faces and provides their location.
-
- face-description: Returns a score for male, female, minor and celebrity for each identified face. Note: Use of this category incurs an additional fee of $0.0015 per image.
-
- ocr: Identifies text within an image and attempts to extract any lexical content.
- foundelsewhere: Returns URL’s for matches found online along with match probability scores. Note: Use of this category incurs an additional fee of $0.06 per image.
Example: cats=porn,extremism,gore,drugs,underwear,alcohol,gambling,id,scam
Example Request
https://im-api1.webpurify.com/v2/services/rest/?api_key=[your_api_key]&format=json&method=webpurify.aim.imgcheck&cats=pornography,gore,ocr&imgurl=https://media.makeameme.org/created/holy-crap-thats-590bde.jpg&pf_api_key=[webpurify_profanity_api_key]
Example Response
{
"rsp": {
"@attributes": {
"stat": "ok"
},
"method": "webpurify.aim.imgcheck",
"format": "rest",
"porn": "86",
"gore": "10",
"drugs": "0.1",
"ocr_text": "holy crap that's kind of a big deal makeameme.org",
"ocr_profanity": "1",
"ocr_profanity_words": "crap"
}
}
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"
}
}
}
}