You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航

添加盲水印

最近更新时间2023.05.19 15:49:37

首次发布时间2022.09.14 20:05:53

本接口支持指定服务以及原图后,将自定义的文字盲水印等信息嵌入原图并获取结果图 Uri。

请求说明

  • 接口名称:CreateImageHmEmbed
  • 请求方式:POST
  • 接口地址示例:https://imagex.volcengineapi.com/?Action=CreateImageHmEmbed&Version=2018-08-01
  • 请求频率限制:50 次/秒
  • 超时时间:30 秒

说明

veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数

Query

参数类型是否必选备注
ActionString接口名称。
VersionString接口版本。veImageX 当前 API 的版本为2018-08-01

Body

参数类型是否必选备注

ServiceId

String

服务 ID。

  • 您可以在 veImageX 控制台 服务管理页面,在创建好的图片服务中获取服务 ID。
  • 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息
StoreUriString待添加盲水印的原图 Uri。

Algorithm

String

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

  • default:文本嵌入模型,默认文本嵌入模型;
  • adapt_resize:画质自适应文本嵌入模型。

Info

String

自定义盲水印文本内容。

  • 文本嵌入模型支持最长可嵌入115个水印内容字符。
  • 画质自适应文本嵌入模型无水印内容长度限制。
OutFormatString输出图片格式,默认 png,支持图片格式有:png、jpeg、webp。

OutQuality

Integer

输出图片质量参数。取值范围为 [1,100],默认为 75。
对于 PNG 无损压缩,其他格式下其值越小,压缩率越高,画质越差。

StrengthLevel

String

算法强度,强度越高,图像抵抗攻击性能越强。
取值如下所示:

  • low:低强度,适用于纯色图场景以及对图像质量要求高;
  • medium:中强度,默认中强度;
  • strong:高强度,适合图像纹理丰富时使用。

返回参数

字段类型描述
StoreUriString添加盲水印后的结果图 Uri。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageHmEmbed&Version=2018-08-01 
{
    "ServiceId":"oz***y2",
    "StoreUri":"tos-boe-i-oz***y2/cf***9d.jpg",
    "Info": "你好 abc123%^$%",
    "OutFormat":"png",
    "StrengthLevel": "strong"
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022082316404301017425518104A49986",
        "Action": "CreateImageHmEmbed",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "StoreUri": "tos-boe-i-oz***y2/9b***76"
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "CreateImageHmEmbed",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
        "Error": {
            "Code": "",
            "Message": ""
        }
    }
}

错误码

访问错误码获取详细信息。