将高级 AI 图片去水印能力集成到产品或工作流程中,自动识别并清除图片中的水印、文字、Logo、商标和印章,智能填充被移除区域并与周围像素自然融合,输出干净自然的结果图。
接口返回的链接一般有效期为 1 小时,请及时下载存储。
鉴权
每个 API 请求都必须在请求头中携带你的 API Key。请按当前文档中的请求方式和参数说明,将其作为 X-API-KEY 请求头传入。
X-API-KEY: YOUR_API_KEY 创建全屏去水印-高级任务
/api/tasks/visual/advanced/watermark-remove 请求参数
image_url string 可选 图片下载地址。支持 HTTP 和 OSS 协议,最长 512 个字符,下载超时 20 秒;同时传入两种图片来源时,优先级低于 image_file。
image_file file 可选 图片文件(二进制)。同时传入 image_file 与 image_url 时优先使用 image_file;以服务端接收到的文件为准,大小必须小于 50MB。
图片上传要求请参看使用规范与限制#5。
sync integer 可选 同步或异步处理。
0:异步返回task_id,随后轮询查询接口;1:同步等待处理完成并直接返回结果。
返回参数
message string 接口返回消息。任务失败时可参考此字段,或携带该信息联系客服。
data.task_id string 异步任务 ID,用于轮询全屏去水印-高级结果。
message string 接口返回消息。任务失败时可参考此字段,或携带该信息联系客服。
data.task_id string 全屏去水印-高级任务 ID。任务失败时请携带此参数联系客服。
data.created_at number 任务创建时间戳。
data.processed_at number 任务开始处理时间戳。
data.completed_at number 任务完成时间戳。
data.image_url string 去水印结果图片下载 URL 或 base64 数据;URL 有效期一般为 1 小时。
data.return_type number 结果返回方式。
data.type number 结果返回方式的兼容字段。
data.progress number 任务处理进度,范围为 0~100;100 表示处理完成。
data.state number 任务处理状态,详见 状态码说明。
1:成功;0或大于 1:处理中;小于 0:失败;-8:处理超时,最长处理时间为 600 秒;-7:无效图片文件;-5:URL 图片超过 50MB;-3:服务器下载图片失败。
data.state_detail string 任务状态详情。
data.time_elapsed number 任务处理耗时。
data.use_point number 本次任务扣费点数。
查询全屏去水印-高级结果
异步请求建议每 1 秒 轮询一次结果,本接口最大轮询时长为 600 秒;累计轮询超过该时长仍未返回结果,即可视为超时失败。
/api/tasks/visual/advanced/watermark-remove/{task_id} 路径参数
task_id string 必填 创建异步全屏去水印-高级任务后返回的任务 ID,用于查询处理结果。
返回参数
message string 接口返回消息。任务失败时可参考此字段,或携带该信息联系客服。
data.task_id string 全屏去水印-高级任务 ID。任务失败时请携带此参数联系客服。
data.created_at number 任务创建时间戳。
data.processed_at number 任务开始处理时间戳。
data.completed_at number 任务完成时间戳。
data.image_url string 去水印结果图片下载 URL 或 base64 数据;URL 有效期一般为 1 小时。
data.return_type number 结果返回方式。
data.type number 结果返回方式的兼容字段。
data.progress number 任务处理进度,范围为 0~100;100 表示处理完成。
data.state number 任务处理状态,详见 状态码说明。
1:成功;0或大于 1:处理中;小于 0:失败;-8:处理超时,最长处理时间为 600 秒;-7:无效图片文件;-5:URL 图片超过 50MB;-3:服务器下载图片失败。
data.state_detail string 任务状态详情。
data.time_elapsed number 任务处理耗时。
data.use_point number 本次任务扣费点数。
使用规范与限制
-
接口返回的链接有效期为 1 小时,请及时下载存储。
-
HTTP status 为 200 表示 HTTP 请求成功;查询结果返回 200 且 data.state 为 1 时表示自动去水印成功,详见 状态码说明。
-
URL 作为参数传递时,请遵守 URL 编码规范,避免参数解析异常。
-
您不得利用本服务从事任何违反法律法规或侵犯他人合法权利的行为。
-
上传图片需符合以下格式和大小限制。
格式 大小 PNG、WebP、JPEG/JPG 小于 50MB
# 全屏去水印-高级 API
将高级 AI 图片去水印能力集成到产品或工作流程中,自动识别并清除图片中的水印、文字、Logo、商标和印章,智能填充被移除区域并与周围像素自然融合,输出干净自然的结果图。
> 注意:接口返回的链接一般有效期为 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。
## 调用方式
- 异步(`sync=0`,推荐):创建请求返回 `data.task_id`,随后轮询查询接口。
- 同步(`sync=1`):创建请求等待处理完成,并直接返回结果。
## 原图来源
`image_url` / `image_file` 至少提供一个;两者同时传入时优先使用 `image_file`。`image_url` 支持 HTTP 和 OSS 协议,最长 512 个字符,下载超时 20 秒。
## 接口列表
| 用途 | 请求方式 | 路径 |
| --- | --- | --- |
| 创建全屏去水印-高级任务 | POST | /api/tasks/visual/advanced/watermark-remove |
| 查询任务结果(异步) | GET | /api/tasks/visual/advanced/watermark-remove/{task_id} |
## 创建全屏去水印-高级任务
`POST /api/tasks/visual/advanced/watermark-remove`
Content-Type: `multipart/form-data`
### 请求参数
| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| image_url | string | image_url / image_file 二选一 | 图片下载地址。支持 HTTP 和 OSS 协议,最长 512 个字符,下载超时 20 秒;同时传入两种图片来源时,优先级低于 image_file。 |
| image_file | file | image_url / image_file 二选一 | 图片文件(二进制)。同时传入 image_file 与 image_url 时优先使用 image_file;以服务端接收到的文件为准,大小必须小于 50MB。 |
| sync | integer | 可选 | 同步或异步处理。 |
### 返回参数 - 异步(sync=0)
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| status | number | HTTP 响应状态码。200 表示请求成功,非 200 表示请求失败。 |
| message | string | 接口返回消息。任务失败时可参考此字段,或携带该信息联系客服。 |
| data.task_id | string | 异步任务 ID,用于轮询全屏去水印-高级结果。 |
### 返回参数 - 同步(sync=1)
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| status | number | HTTP 响应状态码。200 表示请求成功,非 200 表示请求失败。 |
| message | string | 接口返回消息。任务失败时可参考此字段,或携带该信息联系客服。 |
| data.task_id | string | 全屏去水印-高级任务 ID。任务失败时请携带此参数联系客服。 |
| data.created_at | number | 任务创建时间戳。 |
| data.processed_at | number | 任务开始处理时间戳。 |
| data.completed_at | number | 任务完成时间戳。 |
| data.image_url | string | 去水印结果图片下载 URL 或 base64 数据;URL 有效期一般为 1 小时。 |
| data.return_type | number | 结果返回方式。 |
| data.type | number | 结果返回方式的兼容字段。 |
| data.progress | number | 任务处理进度,范围为 0~100;100 表示处理完成。 |
| data.state | number | 任务处理状态。1 表示成功,大于 1 或 0 表示处理中,小于 0 表示失败。 |
| data.state_detail | string | 任务状态详情。 |
| data.time_elapsed | number | 任务处理耗时。 |
| data.use_point | number | 本次任务扣费点数。 |
### cURL 示例
异步,使用图片 URL:
```bash
curl -k 'https://techsz.aoscdn.com/api/tasks/visual/advanced/watermark-remove' \
-H 'X-API-KEY: YOUR_API_KEY' \
-F 'sync=0' \
-F 'image_url=YOUR_IMAGE_URL'
```
异步,上传本地图片:
```bash
curl -k 'https://techsz.aoscdn.com/api/tasks/visual/advanced/watermark-remove' \
-H 'X-API-KEY: YOUR_API_KEY' \
-F 'sync=0' \
-F 'image_file=@/path/to/image.jpg'
```
同步,使用图片 URL:
```bash
curl -k 'https://techsz.aoscdn.com/api/tasks/visual/advanced/watermark-remove' \
-H 'X-API-KEY: YOUR_API_KEY' \
-F 'sync=1' \
-F 'image_url=YOUR_IMAGE_URL'
```
异步创建响应示例:
```json
{ "status": 200, "message": "ok", "data": { "task_id": "TASK_ID" } }
```
## 查询全屏去水印-高级结果
异步请求建议每 **1 秒** 轮询一次结果,本接口最大轮询时长为 **600 秒**;累计轮询超过该时长仍未返回结果,即可视为超时失败。
`GET /api/tasks/visual/advanced/watermark-remove/{task_id}`
### 路径参数
| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| task_id | string | 必填 | 创建异步全屏去水印-高级任务后返回的任务 ID,用于查询处理结果。 |
### 返回参数
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| status | number | HTTP 响应状态码。200 表示请求成功,非 200 表示请求失败。 |
| message | string | 接口返回消息。任务失败时可参考此字段,或携带该信息联系客服。 |
| data.task_id | string | 全屏去水印-高级任务 ID。任务失败时请携带此参数联系客服。 |
| data.created_at | number | 任务创建时间戳。 |
| data.processed_at | number | 任务开始处理时间戳。 |
| data.completed_at | number | 任务完成时间戳。 |
| data.image_url | string | 去水印结果图片下载 URL 或 base64 数据;URL 有效期一般为 1 小时。 |
| data.return_type | number | 结果返回方式。 |
| data.type | number | 结果返回方式的兼容字段。 |
| data.progress | number | 任务处理进度,范围为 0~100;100 表示处理完成。 |
| data.state | number | 任务处理状态。1 表示成功,大于 1 或 0 表示处理中,小于 0 表示失败。 |
| data.state_detail | string | 任务状态详情。 |
| data.time_elapsed | number | 任务处理耗时。 |
| data.use_point | number | 本次任务扣费点数。 |
### cURL 示例
```bash
curl -k 'https://techsz.aoscdn.com/api/tasks/visual/advanced/watermark-remove/{task_id}' \
-H 'X-API-KEY: YOUR_API_KEY'
```
处理完成响应示例:
```json
{
"status": 200,
"message": "success",
"data": {
"task_id": "TASK_ID",
"created_at": 1634884056,
"processed_at": 1634884056,
"completed_at": 1634884056,
"image_url": "https://.../result.png",
"return_type": 1,
"state_detail": "Complete",
"time_elapsed": 53.076,
"use_point": 10,
"progress": 100,
"state": 1
}
}
```
## 推荐异步流程
1. 使用 `sync=0` 和一种原图来源 POST 到 /api/tasks/visual/advanced/watermark-remove。
2. 从创建响应中读取 `data.task_id`。
3. 每 1 秒 GET /api/tasks/visual/advanced/watermark-remove/{task_id},累计轮询不超过 600 秒。
4. 检查 `data.state`:1 = 完成(读取 `data.image_url`);0 或大于 1 = 继续轮询;小于 0 = 失败。
5. 在 1 小时内下载结果图片。
## 使用规范与限制
- 接口返回的链接一般有效期为 **1 小时**,请及时下载存储。
- HTTP status 为 200 仅表示 HTTP 请求成功;data.state = 1 才表示处理成功。
- URL 作为参数传递时,请遵守 URL 编码规范,避免参数解析异常。
- 您不得利用本服务从事任何违反法律法规或侵犯他人合法权利的行为。
- 上传图片需符合以下格式和大小限制。
| 格式 | 大小 |
| --- | --- |
| PNG、WebP、JPEG/JPG | 小于 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 | 处理超时,最长处理时间 600 秒。 |
| -7 | 无效图片文件(如图片损坏、格式不对等)。 |
| -5 | image_url 图片超出大小限制(50MB)。 |
| -3 | 服务器下载图片文件失败,请检查图片 URL 是否可用。 |
| -2 | 处理完成,但上传 OSS 失败。 |
| -1 | 处理失败。 |
| 0 | 排队中,任务正在队列中等待。 |
| 1 | 完成,处理成功。 |
| 2 | 准备中。 |
| 3 | 等待中。 |
| 4 | 处理中,正在进行。 |
| 5 | 内部发布处理中。 |
| 6 | 处理中,内部循环处理中。 |