创建盲水印提取任务（异步）--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

创建盲水印提取任务（异步）

最近更新时间：2025.05.12 20:47:51首次发布时间：2025.05.12 20:47:51

本接口支持指定服务以及提取源图片，获取该图片中的盲水印信息。

使用说明

对同一张图片，请确保在提取水印时指定的模型，与添加水印时指定的模型为同一种，以免无法正常提取水印。
在诸如电子邮件附件、社交媒体平台（如 Facebook、Instagram）、实时通讯应用（如微信）等传输媒介中传输图片时往往会自动压缩图片的分辨率，此时，图片水印也可能无法正常提取。

注意事项

计费说明：盲水印功能属于附加组件下智能处理模块，属于后付费计费，使用后会产生附加组件智能处理费用。
前提条件：请确保已开通智能处理计费配置。
使用限制：提取水印前，请先确认盲水印使用限制。
请求频率：
- 前景图层水印模型（彩色背景通用）：单用户请求频率限制为 3 次/秒。
- 其他模型：单用户请求频率限制为 5 次/秒。
超时时间：约为 50 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=CreateHmExtractTask&Version=2023-05-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数类型是否必选示例值描述

Action String 是 CreateHmExtractTask 接口名称。当前 API 的名称为 CreateHmExtractTask。

Version String 是 2023-05-01 接口版本。当前 API 的版本为 2023-05-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateHmExtractTask`	接口名称。当前 API 的名称为 `CreateHmExtractTask`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`97**sh`	待提取水印图对应的服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

97**sh

待提取水印图对应的服务 ID。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必选	示例值	描述
Strength	String	是	`strong`	盲水印强度，取值如下所示： `low`：低强度，适用于对图像质量要求高。 `medium`：中强度。 `strong`：（推荐）高强度，适合图像纹理丰富时使用。
Algorithm	String	是	`tracev2-app`	算法模型，取值如下： `tracev2`：前景图层水印模型（彩色背景通用） `tracev2-app`：前景图层水印模型（移动端）注意指定 `tracev2`、`tracev2-app` 模型时，请传入已添加对应模型水印的背景网页的截图。若图片错误，则无法提取水印。
ImageUri	String	否	`tos-cn-i-97**sh/example`	待提取盲水印的图片的 URI。`StoreUri` 和 `ImageUrl` 都不为空时，以 `StoreUri` 为准。
ImageUrl	String	否	`https://test.com/example.png`	待提取盲水印图片的 URL。`StoreUri` 和 `ImageUrl` 都不为空时，以 `StoreUri` 为准。
Callback	String	否	`https://example.com/callback`	任务回调地址，回调内容详见盲水印提取回调。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
TaskId	String	`681b538015***5ca5ac14ef3`	任务 ID。

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateHmExtractTask&Version=2023-05-01&ServiceId=97**sh
{
    "Strength": "strong",
    "Algorithm": "tracev2-app"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateHmExtractTask",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskId": "681b538015***5ca5ac14ef3"
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。