Injecting Invisible Watermarks into Images

Updated on 2023-12-07 GMT+08:00

View PDF

Function

This API is used to inject text watermarks or image watermarks into an image. You need to pass an image in formData format to this API. DSC returns the binary stream of the watermarked image. Currently, the supported image formats include *.jpg, .jpeg, .jpe, .png, .bmp, .dib, .rle, .tiff, .tif, .ppm, .webp, .tga, .tpic, and .gif.

URI

POST /v1/{project_id}/image/watermark/embed

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

**Table 3** FormData parameters
Parameter	Mandatory	Type	Description
file	Yes	File	Image into which watermarks are to be injected. The width and height must be greater than 512 pixels.
blind_watermark	No	String	Content of the invisible text watermark, which cannot exceed 32 characters. Currently, only digits and uppercase and lowercase letters are supported. It is used as an alternative of image_watermark.
image_watermark	No	File	Invisible image watermark file to be injected. It is used as an alternative of blind_watermark.

Response Parameters

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Message

Example Requests

Add the invisible text watermark "testWaterMark" to image "test.PNG".

NOTE:

The request is submitted through a form. In the request, "file" indicates a specific file.

POST /v1/{project_id}/image/watermark/embed HTTP/1.1

{
  "blind_watermark" : "testWaterMark",
  "file" : "test.PNG"
}

Example Responses

Status code: 200

Request successful.

"{\"Watermarked image\"}"

Status code: 400

Invalid request.

{
  "error_code" : "DSC.00000007",
  "error_msg" : "File format error"
}

Status Codes

Status Code	Description
200	Request successful.
400	Invalid request.

Error Codes

See Error Codes.

Parent topic: Image Watermarking

Previous topic: Image Watermarking

Next topic: Extracting Invisible Text Watermarks

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel