AI 自动识别并去除图片中的水印区域，输出干净自然的结果图。适用于商品图、海报、素材图等场景，支持异步、同步两种调用方式。
接口返回的链接有效期为 1 小时，请及时下载存储。
鉴权
每个 API 请求都必须在请求头中携带你的 API Key。请按当前文档中的请求方式和参数说明，将其作为 X-API-KEY 请求头传入。
X-API-KEY: YOUR_API_KEY 创建图片自动去水印任务
POST
/api/tasks/visual/external/watermark-remove 请求参数
url string 可选 源图像 URL。如果存在此参数，则其他图像源参数必须为空。
二选一必填
sync integer 可选 是否等待结果就绪并立即返回，默认值为 0。0 表示异步返回 task_id，稍后通过查询接口获取结果；1 表示等待结果准备好后立即返回。请求提交后，结果最多只会保留 1 小时。
返回参数
status number HTTP 响应状态码。200 表示请求成功，非 200 表示请求失败，详见 状态码说明。
message string 返回说明。任务失败时可参考此字段或联系客服。
data.task_id string 图片自动去水印任务 ID，用于轮询结果。
status number HTTP 响应状态码。200 表示请求成功，非 200 表示请求失败，详见 状态码说明。
message string 返回说明。任务失败时可参考此字段或联系客服。
data.task_id string 图片自动去水印任务 ID。如果任务失败，请携带此参数联系客服。
data.created_at string 任务创建时间戳。
data.processed_at string 任务开始处理时间戳。
data.completed_at string 任务完成时间戳。
data.file string 结果图片下载 URL，链接有效期为 1 小时。
data.progress number 任务处理进度。
data.state number 任务处理状态。1 表示成功，大于 1 表示处理中，小于 0 表示失败。-7 表示无效图片文件，详见 状态码说明。
查询图片自动去水印结果
异步请求建议每 1 秒 轮询一次结果，本接口最大轮询时长为 100 秒；累计轮询超过该时长仍未返回结果，即可视为超时失败。
GET
/api/tasks/visual/external/watermark-remove/{task_id} 路径参数
task_id string 必填 创建异步图片自动去水印任务后返回的任务 ID，用于查询任务处理结果。
返回参数
status number HTTP 响应状态码。200 表示请求成功，非 200 表示请求失败，详见 状态码说明。
message string 返回说明。任务失败时可参考此字段或联系客服。
data.task_id string 图片自动去水印任务 ID。如果任务失败，请携带此参数联系客服。
data.created_at string 任务创建时间戳。
data.processed_at string 任务开始处理时间戳。
data.completed_at string 任务完成时间戳。
data.file string 结果图片下载 URL，链接有效期为 1 小时。
data.progress number 任务处理进度。
data.state number 任务处理状态。1 表示成功，大于 1 表示处理中，小于 0 表示失败。-7 表示无效图片文件，详见 状态码说明。
使用规范与限制
-
接口返回的链接有效期为 1 小时，请及时下载存储。
-
HTTP status 为 200 表示 HTTP 请求成功；查询结果返回 200 且 data.state 为 1 时表示自动去水印成功，详见 状态码说明。
-
URL 作为参数传递时，请遵守 URL 编码规范，避免参数解析异常。
-
您不得利用本服务从事任何违反法律法规或侵犯他人合法权利的行为。
-
上传图片需符合以下格式、分辨率和大小限制。
格式 分辨率 大小 jpg, png, bmp 分辨率在20 和 10000像素之间 不超过 50MB（含 50MB）
查看 Markdown
# 图片自动去水印 API
通过 API 自动去除图片中的水印，并返回干净的结果图，支持异步与同步两种调用方式。
> 注意：接口返回的链接有效期为 1 小时，请及时下载存储。
## 接口域名（Base URL）
以下路径均基于接口域名：
```
https://techsz.aoscdn.com
```
## 鉴权
每个请求都必须在请求头中携带你的 API Key：
```http
X-API-KEY: YOUR_API_KEY
```
你可以在 [API Key](https://picwish.cn/my-account?subRoute=api-key) 页面获取或管理 X-API-KEY。
未携带有效 API Key 的请求会被拒绝。
## 调用方式
通过创建请求中的 `sync` 参数选择调用方式：
- 异步（`sync=0`，推荐）：创建请求立即返回 `data.task_id`，随后用该任务 ID 轮询查询接口直到处理完成。
- 同步（`sync=1`）：创建请求等待处理完成，并在同一个响应中直接返回结果。
请求成功后，结果最多只会保留 1 小时。
## 原图来源
必须提供一种原图来源，`url` / `file` 二者互斥：
- `url`：源图像 URL。如果存在此参数，则其他图像源参数必须为空。
- `file`：源图像文件（二进制）。如果此参数存在，则其他图像源参数必须为空。
## 接口列表
| 用途 | 请求方式 | 路径 |
| --- | --- | --- |
| 创建图片自动去水印任务 | POST | /api/tasks/visual/external/watermark-remove |
| 查询任务结果（异步） | GET | /api/tasks/visual/external/watermark-remove/{task_id} |
## 创建图片自动去水印任务
`POST /api/tasks/visual/external/watermark-remove`
Content-Type: `multipart/form-data`
### 请求参数
| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| url | string | url / file 二选一 | 源图像 URL。如果存在此参数，则 file 必须为空。 |
| file | file | url / file 二选一 | 源图像文件（二进制）。如果此参数存在，则 url 必须为空。 |
| sync | integer | 可选 | 0 = 异步返回 task_id，稍后轮询结果；1 = 同步等待并直接返回结果。 |
### 返回参数 - 异步（sync=0）
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| status | number | HTTP 响应状态码。200 表示请求成功，非 200 表示请求失败。详见 /states。 |
| message | string | 返回说明。任务失败时可参考此字段或联系客服。 |
| data.task_id | string | 任务 ID，用于轮询结果。 |
### 返回参数 - 同步（sync=1）
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| status | number | HTTP 响应状态码。200 表示请求成功，非 200 表示请求失败。详见 /states。 |
| message | string | 返回说明。任务失败时可参考此字段或联系客服。 |
| data.task_id | string | 任务 ID。如果任务失败，请携带此参数联系客服。 |
| data.created_at | string | 任务创建时间戳。 |
| data.processed_at | string | 任务开始处理时间戳。 |
| data.completed_at | string | 任务完成时间戳。 |
| data.file | string | 结果图片下载 URL，链接有效期为 1 小时。 |
| data.progress | number | 任务处理进度。 |
| data.state | number | 任务处理状态。1 表示成功，大于 1 表示处理中，小于 0 表示失败；-7 表示无效图片文件。详见 /states。 |
### 示例
异步，使用图片 URL：
```bash
curl -k 'https://techsz.aoscdn.com/api/tasks/visual/external/watermark-remove' \
-H 'X-API-KEY: YOUR_API_KEY' \
-F 'sync=0' \
-F 'url=YOUR_IMAGE_URL'
```
异步，上传本地图片文件：
```bash
curl -k 'https://techsz.aoscdn.com/api/tasks/visual/external/watermark-remove' \
-H 'X-API-KEY: YOUR_API_KEY' \
-F 'sync=0' \
-F 'file=@/path/to/image.jpg'
```
同步，使用图片 URL：
```bash
curl -k 'https://techsz.aoscdn.com/api/tasks/visual/external/watermark-remove' \
-H 'X-API-KEY: YOUR_API_KEY' \
-F 'sync=1' \
-F 'url=YOUR_IMAGE_URL'
```
异步创建响应示例：
```json
{
"status": 200,
"message": "success",
"data": { "task_id": "TASK_ID" }
}
```
## 查询图片自动去水印结果
异步请求建议每 **1 秒** 轮询一次结果，本接口最大轮询时长为 **100 秒**；累计轮询超过该时长仍未返回结果，即可视为超时失败。
`GET /api/tasks/visual/external/watermark-remove/{task_id}`
异步模式下用于轮询获取结果。
### 路径参数
| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| task_id | string | 必填 | 创建异步图片自动去水印任务后返回的任务 ID。 |
### 返回参数
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| status | number | HTTP 响应状态码。200 表示请求成功，非 200 表示请求失败。详见 /states。 |
| message | string | 返回说明。任务失败时可参考此字段或联系客服。 |
| data.task_id | string | 任务 ID。如果任务失败，请携带此参数联系客服。 |
| data.created_at | string | 任务创建时间戳。 |
| data.processed_at | string | 任务开始处理时间戳。 |
| data.completed_at | string | 任务完成时间戳。 |
| data.file | string | 结果图片下载 URL，链接有效期为 1 小时。 |
| data.progress | number | 任务处理进度。 |
| data.state | number | 任务处理状态。1 表示成功，大于 1 表示处理中，小于 0 表示失败；-7 表示无效图片文件。详见 /states。 |
### 示例
```bash
curl -k 'https://techsz.aoscdn.com/api/tasks/visual/external/watermark-remove/{task_id}' \
-H 'X-API-KEY: YOUR_API_KEY'
```
处理完成响应示例：
```json
{
"status": 200,
"message": "success",
"data": {
"task_id": "TASK_ID",
"state": 1,
"progress": 100,
"file": "https://.../result.jpg",
"completed_at": "1634884056"
}
}
```
## 推荐异步流程
1. 使用 `sync=0` 和一种原图来源 POST 到 /api/tasks/visual/external/watermark-remove。
2. 从创建响应中读取 `data.task_id`。
3. 每 1 秒 GET /api/tasks/visual/external/watermark-remove/{task_id}。
4. 检查 `data.state`：1 = 完成（读取 `data.file`）；大于 1 = 继续轮询；小于 0 = 失败。
5. 在 1 小时内下载结果图片。
## 使用规范与限制
- 接口返回的链接有效期为 **1 小时**，请及时下载存储。
- HTTP status 为 200 表示 HTTP 请求成功；查询结果返回 200 且 data.state 为 1 时表示自动去水印成功，详见状态码说明。
- URL 作为参数传递时，请遵守 URL 编码规范，避免参数解析异常。
- 您不得利用本服务从事任何违反法律法规或侵犯他人合法权利的行为。
- 上传图片需符合以下格式、分辨率和大小限制。
| 格式 | 分辨率 | 大小 |
| --- | --- | --- |
| jpg, png, bmp | 分辨率在20 和 10000像素之间 | 不超过 50MB（含 50MB） |
## 状态码
任务是否成功，需要结合 HTTP 响应状态码（`status`）和任务状态码（`data.state`）共同判断。
### HTTP 响应状态码
| 状态码 | 说明 |
| --- | --- |
| 200 | 请求成功。 |
| 400 | 客户端参数传递错误。请检查参数是否缺失或值是否正确。 |
| 401 | 认证失败。请检查 X-API-KEY 是否正确或服务是否开通。 |
| 404 | 请求的 URL 或资源不存在。请检查 URL 或 task_id 是否正确。 |
| 413 | 上传的文件超出大小限制。请参见各服务的最大文件限制。 |
| 429 | 请求频率超出 QPS 限制（默认 QPS 为 2）。请放缓请求速率，或联系商务提升 QPS。 |
| 500 | 服务端异常。请反馈给商务或技术对接人员。 |
### 任务状态码（data.state）
1 = 成功；大于 1 = 处理中；小于 0 = 失败。
| 状态码 | 说明 |
| --- | --- |
| -17 | 处理失败，非法提示词。 |
| -16 | 处理失败，使用第三方检测发现违规。 |
| -15 | 处理失败，资源不足。 |
| -14 | 处理失败，输入图片内容不符合要求。 |
| -13 | 处理失败，任务异常被取消。 |
| -11 | 处理失败，结果为空。 |
| -10 | 处理失败，内部检测非法。 |
| -9 | 处理失败，内部程序循环处理失败。 |
| -8 | 处理超时，最长处理时间 180 秒。 |
| -7 | 无效图片文件（如图片损坏、格式不对等）。 |
| -5 | image_url 图片超出大小限制（30MB）。 |
| -3 | 服务器下载图片文件失败，请检查图片 URL 是否可用。 |
| -2 | 处理完成，但上传 OSS 失败。 |
| -1 | 处理失败。 |
| 0 | 排队中，任务正在队列中等待。 |
| 1 | 完成，处理成功。 |
| 2 | 准备中。 |
| 3 | 等待中。 |
| 4 | 处理中，正在进行。 |
| 5 | 内部发布处理中。 |
| 6 | 处理中，内部循环处理中。 |