This V2.3 automatic watermark removal API provides stronger watermark detection and removal capabilities, with better image quality and detail preservation.
We provide two endpoints: a synchronous API and an asynchronous API.
- The synchronous API returns the processing result directly.
- The asynchronous API returns a
job_id, and you can retrieve the final result by calling the job query endpoint with that job_id.
Both APIs share the same request parameters, including the output image format, whether to remove text in the image, whether to remove logos, and whether to apply image enhancement. You can configure these options as needed.
- Before using the API, make sure you have obtained the API key. Refer to the link below for instructions on how to obtain it. API For API Key Settings
- All generated images will be automatically deleted after 24 hours. Please make sure to save the images you need to your local storage in a timely manner
- API Name: V2.3 Automatic Image Watermark Remover (Synchronous)
- Request URL:
POST /api/web/v1/sync/auto-unwatermark-upgrade-api/creat-job - Request Method: POST
- API Description: V2.3 synchronous watermark removal endpoint. Upload an image and the API returns the processed result directly. Use
output_format to specify the output image format, is_remove_text to control whether text is removed, is_remove_logo to control whether logos are removed, and is_enhancer to enable image enhancement.
| Header Name | Required | Example Value | Description |
|---|
| Content-Type | true | multipart/form-data | Specify request body format |
| ZF-API-KEY | true | xxxxxx...xxxxxx | User Authentication Token |
| Parameter Name | Type | Required | Description |
|---|
| original_image_file | file | true | Original Image File |
| is_remove_text | Boolean | false | Whether to remove text from the image. Default: false. |
| is_remove_logo | Boolean | false | Whether to remove logos from the image. Default: false. |
| is_enhancer | Boolean | false | Whether to apply image enhancement. Default: false. |
| output_format | String | false | Output image format. Default: jpg. |
curl -X POST "https://api.unwatermark.ai/api/web/v1/sync/auto-unwatermark-upgrade-api/creat-job" \
-H "ZF-API-KEY: xxxxxx...xxxxxx" \
-H "Content-Type: multipart/form-data" \
-F "original_image_file=@/path/to/image.jpg" \
-F "is_remove_text=false" \
-F "is_remove_logo=false" \
-F "is_enhancer=false" \
-F "output_format=jpg"
{
"code": 300007,
"message": {
"en": "Task completed successfully",
"zh": "任务完成成功",
"id": "Tugas berhasil diselesaikan"
},
"result": {
"job_id": "bb081a4f-54d0-4509-a7eb-4f2cc9680df9",
"need_credits": 2,
"input_url": "xxxx.jpg",
"output_url": "xxxxx.jpg"
}
}
{
"code": 300008,
"result": {
"job_id": "xxx-xxx-xxx"
},
"message": {
"en": "Task processing failed",
"zh": "任务处理失败",
"id": "Pemrosesan tugas gagal"
}
}
- API Name: V2.3 Automatic Image Watermark Remover (Asynchronous)
- Request URL:
POST /api/web/v1/async/auto-unwatermark-upgrade-api/creat-job - Request Method: POST
- API Description: V2.3 asynchronous watermark removal endpoint. This API creates a task and returns a
job_id but does not return the processed result directly. Use the returned job_id with the job query endpoint to retrieve the final result. The request parameters are identical to the synchronous API: original_image_file for the input image, output_format for output format, is_remove_text for text removal, is_remove_logo for logo removal, and is_enhancer for image enhancement.
| Header Name | Required | Example Value | Description |
|---|
| Content-Type | true | multipart/form-data | Specify request body format |
| ZF-API-KEY | true | xxxxxx...xxxxxx | User Authentication Token |
| Parameter Name | Type | Required | Description |
|---|
| original_image_file | file | true | Original Image File |
| is_remove_text | Boolean | false | Whether to remove text from the image. Default: false. |
| is_remove_logo | Boolean | false | Whether to remove logos from the image. Default: false. |
| is_enhancer | Boolean | false | Whether to apply image enhancement. Default: false. |
| output_format | String | false | Output image format. Default: jpg. |
curl -X POST "https://api.unwatermark.ai/api/web/v1/async/auto-unwatermark-upgrade-api/creat-job" \
-H "ZF-API-KEY: xxxxxx...xxxxxx" \
-H "Content-Type: multipart/form-data" \
-F "original_image_file=@/path/to/image.jpg" \
-F "is_remove_text=false" \
-F "is_remove_logo=false" \
-F "is_enhancer=false" \
-F "output_format=jpg"
{
"code": 300000,
"message": {
"en": "Task created successfully",
"zh": "任务创建成功",
"id": "Tugas berhasil dibuat"
},
"result": {
"job_id": "61243789-850c-473a-85ae-ee70dfef90b1",
"need_credits": 2
}
}
{
"code": 300008,
"result": {
"job_id": "xxx-xxx-xxx"
},
"message": {
"en": "Task processing failed",
"zh": "任务处理失败",
"id": "Pemrosesan tugas gagal"
}
}
- API Name: V2.3 Automatic Image Watermark Remover - Job Query
- Request URL:
GET /api/web/v1/async/auto-unwatermark-upgrade-api/get-job/{job_id} - Request Method: GET
- API Description: Use the
job_id returned by the asynchronous V2.3 watermark removal create-job API to query and retrieve the image processing result.
| Header Name | Required | Example Value | Description |
|---|
| ZF-API-KEY | true | xxxxxx...xxxxxx | User Authentication Token |
| Parameter Name | Type | Required | Description |
|---|
| job_id | string | true | Job ID from create |
curl -X GET "https://api.unwatermark.ai/api/web/v1/async/auto-unwatermark-upgrade-api/get-job/{job_id}" \
-H "ZF-API-KEY: xxxxxx...xxxxxx"
{
"code": 300006,
"message": {
"en": "Task is processing",
"zh": "任务处理中",
"id": "Tugas sedang diproses"
},
"result": {
"job_id": "9ead79eb-745f-4010-a186-751b060caa7f",
"input_url": "xxxxx.jpg"
}
}
{
"code": 100000,
"message": {
"en": "Task completed successfully",
"zh": "任务完成成功",
"id": "Tugas berhasil diselesaikan"
},
"result": {
"job_id": "61243789-850c-473a-85ae-ee70dfef90b1",
"input_url": "xxxxx.jpg",
"output_url": "xxxxx.jpg"
}
}
{
"code": 300008,
"result": {
"input_url": "xxxxx.jpg",
"job_id": "xxx-xxx-xxx"
},
"message": {
"en": "Task processing failed",
"zh": "任务处理失败",
"id": "Pemrosesan tugas gagal"
}
}
