Full-Screen Watermark Removal - Advanced API

Try on PicWish

Integrate advanced AI watermark removal into your product or workflow. Automatically detect and remove watermarks, text, logos, trademarks, and stamps, then intelligently fill removed areas and blend them with surrounding pixels for clean, natural results.

The result image URL is generally valid for 1 hour. Please download and store it promptly.

Authentication

Every API request must include your API Key in the X-API-KEY request header. Send it with each request exactly as shown in the examples and parameter descriptions.

X-API-KEY: YOUR_API_KEY

Create a Full-Screen Watermark Removal - Advanced task

POST /api/tasks/visual/advanced/watermark-remove

Body Parameters

image_url string optional

Image download URL. Supports HTTP and OSS, up to 512 characters, with a 20-second download timeout. If both sources are provided, image_file takes precedence.

one required

image_file file optional

Source image file as binary data. If image_file and image_url are both provided, image_file takes precedence. The file received by the server must be less than 50MB.

For image upload requirements, see Guidelines and Limits #5.

sync integer optional

Synchronous or asynchronous processing.

0: Return a task_id asynchronously, then poll the query endpoint;
1: Wait for processing to finish and return the result synchronously.

Return Parameters

status number

HTTP response status code. See Status Code Definitions.

200: Request succeeded;
Non-200: Request failed.

message string

Response message. If the task fails, refer to this field or contact support with it.

data.task_id string

Asynchronous task ID used to poll the Full-Screen Watermark Removal - Advanced result.

status number

HTTP response status code. See Status Code Definitions.

200: Request succeeded;
Non-200: Request failed.

message string

Response message. If the task fails, refer to this field or contact support with it.

data.task_id string

Full-Screen Watermark Removal - Advanced task ID. If the task fails, contact support with this task_id.

data.created_at number

Timestamp of task creation.

data.processed_at number

Timestamp when the task started processing.

data.completed_at number

Timestamp of task completion.

data.image_url string

Watermark-removed result image URL or base64 data. A returned URL is generally valid for 1 hour.

data.return_type number

Result return method.

data.type number

Compatibility field for the result return method.

data.progress number

Task progress from 0 to 100. A value of 100 means processing is complete.

data.state number

Task status. See Status Code Definitions.

1: Succeeded;
0 or > 1: Processing;
< 0: Failed;
-8: Processing timed out after at most 600 seconds;
-7: Invalid image file;
-5: The URL image exceeds 50MB;
-3: The server failed to download the image.

data.state_detail string

Detailed task status.

data.time_elapsed number

Elapsed processing time.

data.use_point number

Credits consumed by this task.

Query Full-Screen Watermark Removal - Advanced result

For asynchronous requests, poll the result once every 1 second. The maximum polling duration for this API is 600 seconds; if the total polling time exceeds this without a result, treat it as a timeout failure.

GET /api/tasks/visual/advanced/watermark-remove/{task_id}

Path Parameters

task_id string required

Task ID returned after creating an asynchronous Full-Screen Watermark Removal - Advanced task. Use it to query the result.

Return Parameters

status number

HTTP response status code. See Status Code Definitions.

200: Request succeeded;
Non-200: Request failed.

message string

Response message. If the task fails, refer to this field or contact support with it.

data.task_id string

Full-Screen Watermark Removal - Advanced task ID. If the task fails, contact support with this task_id.

data.created_at number

Timestamp of task creation.

data.processed_at number

Timestamp when the task started processing.

data.completed_at number

Timestamp of task completion.

data.image_url string

Watermark-removed result image URL or base64 data. A returned URL is generally valid for 1 hour.

data.return_type number

Result return method.

data.type number

Compatibility field for the result return method.

data.progress number

Task progress from 0 to 100. A value of 100 means processing is complete.

data.state number

Task status. See Status Code Definitions.

1: Succeeded;
0 or > 1: Processing;
< 0: Failed;
-8: Processing timed out after at most 600 seconds;
-7: Invalid image file;
-5: The URL image exceeds 50MB;
-3: The server failed to download the image.

data.state_detail string

Detailed task status.

data.time_elapsed number

Elapsed processing time.

data.use_point number

Credits consumed by this task.

Guidelines and Limits

The result image URL is valid for 1 hour. Please download and store it promptly.
HTTP status 200 means the HTTP request succeeded; for result queries, status 200 with data.state = 1 means watermark removal succeeded. See Status Code Definitions.
When passing URLs as parameters, follow URL encoding standards to prevent parameter parsing issues.
You must not use this service for any activity that violates laws, regulations, or the legitimate rights of others.
Uploaded images must meet the following format and file size limits.

Format Size

PNG, WebP, JPEG/JPG Less than 50MB

Format	Size
PNG, WebP, JPEG/JPG	Less than 50MB

Response

{
  "status": 200,
  "message": "success",
  "data": {
    "task_id": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "created_at": 1634884056, // Only present in async polling results.
    "processed_at": 1634884056, // Only present in async polling results.
    "completed_at": 1634884056, // Only present in async polling results.
    "image_url": "https://wxtechhk.oss-hongkong.aliyuncs.com/tasks/output/visual_external_image_edit/93a5e47b-a9c1-47ac-9b5e-22cb89f7d358-image_0.png", // Only present in async polling results.
    "return_type": 1, // Only present in async polling results.
    "state_detail": "Complete", // Only present in async polling results.
    "time_elapsed": 53.076, // Only present in async polling results.
    "use_point": 10, // Only present in async polling results.
    "progress": 100, // Only present in async polling results.
    "state": 1 // Only present in async polling results.
  }
}