image watermark - Img Open English

Request

Header Params

X-Request-req-accessKeyId

string

optional

X-Request-req-accessKeySecret

string

optional

Body Params application/json

businessTaskId

string

required

imageUrl

string

image url

required

text

string

Text watermark content

optional

fontSize

integer

text size

optional

Range [20,100], precision 1; pixel value corresponding to text character height, final effect is affected by image size

textRegionNum

integer

Text watermark adding area

optional

Range [1,9], precision 1; divide the picture into a nine-square grid, 1~9 respectively correspond to nine areas: upper left, upper middle, upper right, middle left, middle middle, middle right, lower left, lower middle, and lower right.

textTransparency

integer

Text watermark transparency

optional

Range [0,1], precision 0.01; adjust text watermark transparency

color

array[integer]

Text watermark color

optional

The default value is [255,255,255], which is white

watermarkUrl

string

Image watermark url

optional

imageRegionNum

integer

Image watermark adding area

optional

Range [0,1], precision 0.01; adjust image watermark transparency

scalingRatio

integer

Image watermark scaling ratio

optional

Range [0.25, 2.0], precision 0.01; adjust the final size of the image watermark

imageTransparency

integer

Image watermark transparency

optional

Range [0,1], precision 0.01; adjust image watermark transparency

ext

string

Picture saving format

optional

Range {'png','jpg','jpeg','webp'}; if the incoming format is not supported, the default format png is used

callbackUrl

string

callback address

optional

Example

{
  "businessTaskId": "test111",
  "text": "This is a watermark",
  "imageUrl": "https://dbt-aigc.oss-cn-hangzhou.aliyuncs.com/Output-Img2/zjy/three_test.webp",
  "watermarkUrl": "https://dbt-aigc.oss-cn-hangzhou.aliyuncs.com/Output-Img2/zjy/bali_bao.png",
  "ext": "webp",
  "textTransparency": 1,
  "imageTransparency": 1,
  "scalingRatio": 2,
  "textRegionNum": 2,
  "imageRegionNum": 8
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.zhiqite.com/AIGCImgOpenServ/saas/tool/image/watermark' \
--header 'X-Request-req-accessKeyId;' \
--header 'X-Request-req-accessKeySecret;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "businessTaskId": "test111",
  "text": "This is a watermark",
  "imageUrl": "https://dbt-aigc.oss-cn-hangzhou.aliyuncs.com/Output-Img2/zjy/three_test.webp",
  "watermarkUrl": "https://dbt-aigc.oss-cn-hangzhou.aliyuncs.com/Output-Img2/zjy/bali_bao.png",
  "ext": "webp",
  "textTransparency": 1,
  "imageTransparency": 1,
  "scalingRatio": 2,
  "textRegionNum": 2,
  "imageRegionNum": 8
}'

Responses

🟢200OK

application/json

Body

code

string

required

msg

string

required

data

object

required

businessTaskId

string

required

outputImageUrl

string

required

Output image url

status

integer

required

Task status

taskId

string

required

Example

{
  "code": "string",
  "msg": "string",
  "data": {
    "businessTaskId": "string",
    "outputImageUrl": "string",
    "status": 0,
    "taskId": "string"
  }
}