image-advertisement-detection
Image Advertisement Detection
Automatically detect advertising features like watermarks, QR codes, barcodes, and mini-program codes in images, returning violation types and confidence levels to assist platform content moderation.
Usage Cost
5 coins/call
Quick Start
Use a unified response envelope and call directly from your backend.
https://openapi.toolkk.com/v1/image-advertisement-detectioncURL Example
curl --request POST \
--url 'https://openapi.toolkk.com/v1/image-advertisement-detection' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: YOUR_API_KEY' \
--data '{\n "imageBase64": "iVBORw0KGgo...",\n "imgType": "0"\n}'Python Example
import os
import requests
url = "https://openapi.toolkk.com/v1/image-advertisement-detection"
payload = {
"imageBase64": "iVBORw0KGgo...",
"imgType": "0"
}
headers = {
"Content-Type": "application/json",
"X-API-Key": os.getenv("TOOLKK_API_KEY", "YOUR_API_KEY"),
}
response = requests.request("POST", url, headers=headers, json=payload, timeout=30)
response.raise_for_status()
print(response.json())Go Example
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
endpoint := "https://openapi.toolkk.com/v1/image-advertisement-detection"
payload := []byte("{\n \"imageBase64\": \"iVBORw0KGgo...\",\n \"imgType\": \"0\"\n}")
req, err := http.NewRequest("POST", endpoint, bytes.NewBuffer(payload))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}Java Example
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ToolkkExample {
public static void main(String[] args) throws Exception {
String payload = "{\n \"imageBase64\": \"iVBORw0KGgo...\",\n \"imgType\": \"0\"\n}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://openapi.toolkk.com/v1/image-advertisement-detection"))
.method("POST", HttpRequest.BodyPublishers.ofString(payload))
.header("Content-Type", "application/json")
.header("X-API-Key", "YOUR_API_KEY")
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}PHP Example
<?php
$endpoint = 'https://openapi.toolkk.com/v1/image-advertisement-detection';
$payload = "{\n \"imageBase64\": \"iVBORw0KGgo...\",\n \"imgType\": \"0\"\n}";
$ch = curl_init($endpoint);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'X-API-Key: YOUR_API_KEY',
],
CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
curl_close($ch);
echo $response;Response Example
{
"result": "2",
"resultMsg": "不合规",
"resultItems": [
{
"nonComplianceType": 0,
"msg": "存在水印",
"probability": 0.91
}
]
}Examples illustrate the response structure. Actual results depend on the API response.
- Authentication
- Send X-API-Key in request headers
- Rate limit
- 20 req/min
- Timeout
- 30000 ms
Send your API Key in the X-API-Key header from your backend.
Check both HTTP status and business fields before treating a call as successful.
Use retries and backoff together with rate limits in high-frequency scenarios.
Request Fields
Send requests from your server with the key in the X-API-Key header.
Request Fields
The fields below are derived from example JSON for integration reference only.
| Path | Type | Required | Description | Sample |
|---|---|---|---|---|
| imageBase64 | string | Unspecified | Unspecified | iVBORw0KGgo... |
| imgType | string | Unspecified | Unspecified | 0 |
Request Example
{
"imageBase64": "iVBORw0KGgo...",
"imgType": "0"
}- Authentication
- Send X-API-Key in request headers
- Rate limit
- 20 req/min
- Timeout
- 30000 ms
Response Fields
Examples illustrate the response structure. Actual results depend on the API response.
Response Fields
The fields below are derived from example JSON for integration reference only.
| Path | Type | Required | Description | Sample |
|---|---|---|---|---|
| result | string | Unspecified | Unspecified | 2 |
| resultMsg | string | Unspecified | Unspecified | 不合规 |
| resultItems | array | Unspecified | Unspecified | [{"nonComplianceType":0,"msg":"存在水印","probability":0.91}] |
| resultItems[] | object | Unspecified | Unspecified | {...} |
| resultItems[].nonComplianceType | number | Unspecified | Unspecified | 0 |
| resultItems[].msg | string | Unspecified | Unspecified | 存在水印 |
| resultItems[].probability | number | Unspecified | Unspecified | 0.91 |
Response Example
{
"result": "2",
"resultMsg": "不合规",
"resultItems": [
{
"nonComplianceType": 0,
"msg": "存在水印",
"probability": 0.91
}
]
}$.code == 200API overview
Capabilities, use cases, limitations, and frequently asked questions.
API Capabilities
This API specializes in automated detection of image advertising features. By analyzing the Base64 encoding of uploaded images, the system can efficiently identify various advertising elements that may be hidden in images, including but not limited to watermarks, QR codes, barcodes, and mini-program codes. The API returns the overall compliance judgment result, specific violation type descriptions, and corresponding confidence probabilities, helping developers quickly filter out non-compliant marketing images.
Request and Response
- Request Parameters: Requires
imageBase64(Base64 encoding of the image to be detected) andimgType(image type or scenario identifier, e.g., "0"). - Response Results: Returns a JSON-formatted detection report, including
result(overall judgment status code, e.g., 2 indicates non-compliance),resultMsg(judgment result description), andresultItems(list of specific violation items). Violation items will detailnonComplianceType(violation type code),msg(e.g., "watermark detected"), andprobability(confidence probability).