Remove Watermark
Automatically identify and remove watermarks, logos, or other unwanted overlay elements from an image, or remove specified areas directly.
Create Task
| Item | Value |
|---|
| Request Method | POST |
| Request Path | /task/image_purify |
| Content-Type | application/json |
| Authentication | Raw API key in the Authorization header |
Request Body
| Parameter | Type | Required | Default | Description |
|---|
file_id | string | Yes | - | Uploaded image file ID |
purify_scope | string | No | "full_screen" | Cleanup scope: full_screen (identify and remove automatically) / region (remove the boxes given by regions directly) |
regions | array | Required when region | - | Areas to remove directly, 1–16 boxes, each {"x","y","w","h"} as 0-1 frame ratios, with w>0, h>0, x+w≤1, y+h≤1 |
Request Example
curl -X POST https://api.ai-mcn.tv:10000/task/image_purify \
-H "Authorization: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"file_id": "537489015178246"}'
region mode example (remove the logo in the top-left corner):
curl -X POST https://api.ai-mcn.tv:10000/task/image_purify \
-H "Authorization: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"file_id": "537489015178246",
"purify_scope": "region",
"regions": [{"x": 0.02, "y": 0.02, "w": 0.15, "h": 0.08}]
}'
region mode does no recognition — everything inside the box is processed, including the main subject. Use it for dark logos or graphic stickers that cannot be recognized; smaller boxes that fit the element tightly give better results.
Success Example
{
"code": 200,
"msg": "success",
"data": {
"task_id": "537489015178247",
"task_type": "image_purify",
"status": "queued"
}
}
Query Task Result
| Item | Value |
|---|
| Request Method | GET |
| Request Path | /task/image_purify/{task_id} |
| Authentication | Raw API key in the Authorization header |
Output Result (output_result)
| Parameter | Type | Description |
|---|
file_id | string | Processed image file ID |
Success Example
{
"code": 200,
"msg": "success",
"data": {
"task_id": "537489015178247",
"status": "completed",
"progress": 100,
"output_result": {
"file_id": "537489015178248"
},
"create_time": "2026-04-05T08:00:00Z",
"update_time": "2026-04-05T08:00:08Z"
}
}
Error Codes
| Error Code | HTTP Status | Description | Resolution |
|---|
6013 | 400 | Missing file_id | Pass the file_id field |
6016 | 400 | Invalid purify_scope, or missing or invalid regions in region mode (empty, more than 16 boxes, or out-of-range coordinates) | Check purify_scope / regions |
6014 | 400 | File type does not match the task | Upload an image file |
6004 | 404 | File not found | Verify the file_id |
6502 | 401 | Authentication failed | Check the Authorization header |
6202 | 402 | Insufficient balance | Recharge in the Dashboard |