Updated on 2026-01-13 GMT+08:00

Adding Watermarks to Multiple Documents

Function

This API is used to add watermarks to multiple documents in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/sdg/watermark/batch-embed

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

blind_watermark

No

String

Invisible watermark content.

dest_url

No

String

Target URL.

doc_paths

No

Array of strings

Document path list.

doc_type

No

String

Document type.

file_url

No

String

File URL.

font_size

No

Integer

Font size of the visible watermark.

opacity

No

Float

Watermark transparency.

project_id

No

String

Project ID.

remark

No

String

Remarks.

rotation

No

Integer

Watermark rotation angle.

sparse_degree

No

Integer

Watermark sparsity.

state

No

Integer

Task status.

task_name

No

String

Task name.

type

No

String

Type.

visible_watermark

No

String

Visible watermark.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Task ID.

msg

String

Message description.

status

String

Status.

Status code: 201

Task created.

Example Requests

POST /v1/{project_id}/sdg/watermark/batch-embed

{
  "blind_watermark" : "555",
  "dest_url" : "string",
  "doc_paths" : [ "string" ],
  "doc_type" : "LOCAL",
  "file_url" : "string",
  "font_size" : 30,
  "opacity" : 0.5,
  "rotation" : 45,
  "sparse_degree" : 0,
  "task_name" : "test",
  "visible_watermark" : "666"
}

Example Responses

None

Status Codes

Status Code

Description

200

Embedded.

201

Task created.

401

Unauthorized.

403

Access denied.

404

Project not found.

Error Codes

See Error Codes.