Help Center/ Data Security Center/ API Reference/ API Description/ Document Watermarking/ Extracting Watermarks from Multiple Documents
Updated on 2026-01-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Extracting Watermarks from Multiple Documents

Function

This API is used to extract watermarks from multiple documents in batches.

Calling Method

For details, see Calling APIs.

URI

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

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

doc_paths

No

Array of strings

File path list.

doc_type

No

String

Document type.

file_url

No

String

File URL.

project_id

No

String

Project ID.

task_name

No

String

Task name.

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-extract

{
  "doc_paths" : [ "string" ],
  "doc_type" : "LOCAL",
  "file_url" : "string",
  "task_name" : "test"
}

Example Responses

None

Status Codes

Status Code

Description

200

Extracted.

201

Task created.

401

Unauthorized.

403

Access denied.

404

Project not found.

Error Codes

See Error Codes.

Parent topic: Document Watermarking