Result Query
Update:
hidden = true
This is the V1 API. The V2 API is now available with a cleaner request/response structure and is recommended: Result Query (V2).
Request specification
- Request URL:
https://isafe.ilivedata.com/api/v1/image/check/async/result
- Interface description:
The interface is used to obtain the results of image asynchronous check.
- HTTP Request Header:
Header
Value
Description
Content-Type
application/json;charset=UTF-8
Request body type
Accept
application/json;charset=UTF-8
Accepted return type
X-AppId
The only identifier of the project or application.
X-TimeStamp
UTC Timestamp of the request, which needs to be normalized in accordance with W3C standards, for example: 2010-01-31T23:59:59Z. (http://www.w3.org/TR/xmlschema-2/#dateTime)
Authorization
Signature value
-
Request method:POST
-
Request body JSON object:
Parameter
Necessity
Type
Description
taskId
Required
String
The taskId to which we return after calling successfully the image submission interface.
-
Example of request body:
{
"taskId": "us_******************"
}
-
Request signature:
This API requires the Authorization signature in the request Header. For the signature calculation rule, see Request Signature.
HTTP Response
Content-Type: application/json;charset=UTF-8
The result is in JSON format, please refer to the following example.
- HTTP response
Description of returning json field:
Parameter
Type
Description
errorCode
Number
Error code: 0 means success
errorMessage
String
Error message
imageSpams
json array
Resut message
code
Number
Status code, defined as: 0: successful detection, 1: image download failed, 2: image format error, 3: other
result
Number
0: Pass, 1: Recommended for review, 2: Fail
taskId
String
Task ID
imageSpams:
Parameter
Type
Description
code
Number
Status code, defined as: 0: successful detection, 1: image download failed, 2: image format error, 3: other
result
Number
0: Pass, 1: Recommended for review, 2: Fail
tags
json array
Classified information
extraInfo:
Parameter
Type
Description
cartoonScore
Number
Score for cartoon style, 0-100, the higher the score, the closer to the cartoon style
genderResult
json array
Gender and its confidence
numHuman
Number
Number of human
numFace
Number
Number of face
tags:
Parameter
Type
Description
tag
Number
Tags meaning:
100:Politics, 110:Violence, 120:Prohibited, 130:porn, 140:sexy, 150:ad, 160:values, 180:minor, 190:tamper, 200:QR code, 230:no human face, 232:picture quality, 300:logo, 400:ocr, 666:disgust, 800:label, 900:others, 999:customize
level
Number
Classification level, 0: normal, 1: suspected, 2: abnormal
confidence
Number
Confidence score: values between 0-100. 100 is the highest confidence level, and 0 is the lowest confidence level. If the level is suspected or abnormal, the greater the confidence level, the higher the possibility of spam
tagName
String
Detect first-level type names for image hits
tagNameEn
String
Detect first-level type names for image hits(English)
subTags
json object
Secondary classification of sensitive information
wordList
array of strings
OCR only (tag=400)
subTags:
Parameter
Type
Description
subTag
Number
Secondary classification information reference Classification Code
subTagName
String
Detect secondary type names for iamge hits
subTagNameEn
String
Detect secondary type names for image hits(English)
level
Number
Classification level, 0: normal, 1: suspected, 2: abnormal
confidence
Number
Confidence score: values between 0-100. 100 is the highest confidence level, and 0 is the lowest confidence level. If the level is suspected or abnormal, the greater the confidence level, the higher the possibility of spam
wordList
array of strings
OCR only (tag=400)
-
Example of response:
{
"errorCode": 0,
"code": 0,
"result": 2,
"imageSpams": [
{
"code": 0,
"result": 2,
"tags": [
{
"tag": 110,
"level": 2,
"confidence": 95,
"tagName": "暴恐",
"tagNameEn": "Violence",
"subTags": [
{
"subTag": 110008,
"subTagName": "枪支器械",
"subTagNameEn": "guns and knife",
"level": 2,
"confidence": 95
}
]
}
]
}
],
"gender": [
],
"taskId": "us_d56b5c2d38614be3bf1a1e98663d3c29_1653017203620",
"extraInfo": {
"cartoonScore": 7,
"genderResult": [
],
"numHuman": 0,
"numFace": 0
}
}
Error Codes
See Common Exception Codes in Help Center
hidden = true
This is the V1 API. The V2 API is now available with a cleaner request/response structure and is recommended: Result Query (V2).
Request specification
- Request URL:
https://isafe.ilivedata.com/api/v1/image/check/async/result
- Interface description:
The interface is used to obtain the results of image asynchronous check.
- HTTP Request Header:
| Header | Value | Description |
|---|---|---|
| Content-Type | application/json;charset=UTF-8 | Request body type |
| Accept | application/json;charset=UTF-8 | Accepted return type |
| X-AppId | The only identifier of the project or application. | |
| X-TimeStamp | UTC Timestamp of the request, which needs to be normalized in accordance with W3C standards, for example: 2010-01-31T23:59:59Z. (http://www.w3.org/TR/xmlschema-2/#dateTime) | |
| Authorization | Signature value |
-
Request method:POST
-
Request body JSON object:
| Parameter | Necessity | Type | Description |
|---|---|---|---|
| taskId | Required | String | The taskId to which we return after calling successfully the image submission interface. |
-
Example of request body:
{ "taskId": "us_******************" } -
Request signature:
This API requires the Authorization signature in the request Header. For the signature calculation rule, see Request Signature.
HTTP Response
Content-Type: application/json;charset=UTF-8
The result is in JSON format, please refer to the following example.
- HTTP response
Description of returning json field:
Parameter |
Type |
Description |
|---|---|---|
| errorCode | Number | Error code: 0 means success |
| errorMessage | String | Error message |
| imageSpams | json array | Resut message |
| code | Number | Status code, defined as: 0: successful detection, 1: image download failed, 2: image format error, 3: other |
| result | Number | 0: Pass, 1: Recommended for review, 2: Fail |
| taskId | String | Task ID |
imageSpams:
Parameter |
Type |
Description |
|---|---|---|
| code | Number | Status code, defined as: 0: successful detection, 1: image download failed, 2: image format error, 3: other |
| result | Number | 0: Pass, 1: Recommended for review, 2: Fail |
| tags | json array | Classified information |
extraInfo:
| Parameter | Type | Description |
|---|---|---|
| cartoonScore | Number | Score for cartoon style, 0-100, the higher the score, the closer to the cartoon style |
| genderResult | json array | Gender and its confidence |
| numHuman | Number | Number of human | numFace | Number | Number of face |
tags:
Parameter |
Type |
Description |
|---|---|---|
| tag | Number | Tags meaning: 100:Politics, 110:Violence, 120:Prohibited, 130:porn, 140:sexy, 150:ad, 160:values, 180:minor, 190:tamper, 200:QR code, 230:no human face, 232:picture quality, 300:logo, 400:ocr, 666:disgust, 800:label, 900:others, 999:customize |
| level | Number | Classification level, 0: normal, 1: suspected, 2: abnormal |
| confidence | Number | Confidence score: values between 0-100. 100 is the highest confidence level, and 0 is the lowest confidence level. If the level is suspected or abnormal, the greater the confidence level, the higher the possibility of spam |
| tagName | String | Detect first-level type names for image hits |
| tagNameEn | String | Detect first-level type names for image hits(English) |
| subTags | json object | Secondary classification of sensitive information |
| wordList | array of strings | OCR only (tag=400) |
subTags:
Parameter |
Type |
Description |
|---|---|---|
| subTag | Number | Secondary classification information reference Classification Code |
| subTagName | String | Detect secondary type names for iamge hits |
| subTagNameEn | String | Detect secondary type names for image hits(English) |
| level | Number | Classification level, 0: normal, 1: suspected, 2: abnormal |
| confidence | Number | Confidence score: values between 0-100. 100 is the highest confidence level, and 0 is the lowest confidence level. If the level is suspected or abnormal, the greater the confidence level, the higher the possibility of spam |
| wordList | array of strings | OCR only (tag=400) |
-
Example of response:
{ "errorCode": 0, "code": 0, "result": 2, "imageSpams": [ { "code": 0, "result": 2, "tags": [ { "tag": 110, "level": 2, "confidence": 95, "tagName": "暴恐", "tagNameEn": "Violence", "subTags": [ { "subTag": 110008, "subTagName": "枪支器械", "subTagNameEn": "guns and knife", "level": 2, "confidence": 95 } ] } ] } ], "gender": [ ], "taskId": "us_d56b5c2d38614be3bf1a1e98663d3c29_1653017203620", "extraInfo": { "cartoonScore": 7, "genderResult": [ ], "numHuman": 0, "numFace": 0 } }
Error Codes
See Common Exception Codes in Help Center