Help Center> Data Security Center> API Reference> API Description> Image Watermarking> Extracting Invisible Text Watermarks
Updated on 2024-03-29 GMT+08:00
Online Debugging
CLI Examples
View PDF

Extracting Invisible Text Watermarks

Function

This API is used to extract text watermarks from images. You need to pass an image in formData format to this API. DSC returns the extracted invisible text watermarks in JSON format. 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/extract

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 from which invisible watermarks are to be extracted.

mark_len

No

String

Length of the watermark to be extracted. The length of mark_len is greater than 0 and less than 32.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

watermark

String

Invisible watermark. The length cannot exceed 32 characters.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Message

Example Requests

Extract the invisible text watermark from image "test.PNG".

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

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

{
  "file" : "test.PNG"
}

Example Responses

Status code: 200

Request successful.

{
  "watermark" : "mark!"
}

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