You need to enable JavaScript to run this app.
导航
提取盲水印
最近更新时间:2024.06.03 17:41:01首次发布时间:2024.04.26 11:06:58

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

注意

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

注意事项

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

请求说明

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

调试

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringCreateImageHmExtract接口名称。当前 API 的名称为 CreateImageHmExtract
VersionString2023-05-01接口版本。当前 API 的版本为 2023-05-01

ServiceId

String

97**sh

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

  • 您可以在 veImageX 控制台 服务管理页面,在创建好的图片服务中获取服务 ID。
  • 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息
StoreUriStringtos-cn-i-97**sh/example待提取盲水印的图片的 URI。StoreUriImageUrl 都不为空时,以 StoreUri 为准。
ImageUrlStringhttps://test.com/example.png待提取盲水印图片的 URL。StoreUriImageUrl 都不为空时,以 StoreUri 为准。

Algorithm

String

default

算法模型,取值如下所示:

  • default:文本嵌入基础模型
  • adapt_resize:画质自适应文本嵌入模型。
  • adapt: 文本嵌入自适应模型(AIGC 适用)
  • natural:文本嵌入基础模型(彩色图片通用)
  • tracev1:前景图层水印模型

    注意

    指定 tracev1 模型时,请传入已添加该模型水印的纯色背景网页的截图

返回参数

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

参数类型示例值描述

StatusCode

Integer

0

响应码,取值如下所示:

  • -1:盲水印为空。
  • 0info不为空时表示盲水印提取成功。

说明

提取失败时显示接口错误。

InfoString你好 abc123%^$%提取出的盲水印文本信息。

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageHmExtract&Version=2023-05-01&ServiceId=97**sh&StoreUri=tos-cn-i-97**sh/example&Algorithm=default&ImageUrl=https://test.com/example.png

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateImageHmExtract",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "StatusCode": 0,
        "Info": "你好 abc123%^$%"
    }
}

错误码

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

服务端 SDK

为了方便您快速开发,veImageX 提供了配套的服务端 SDK,同时支持多种编程语言。建议您使用服务端 SDK 来调用 API,参考文档如下所示: