This page was machine-translated. Spotted a mistake?Help improve it.
Skip to content

Redact PDF

使用经验证的真正涂黑从 PDF 中永久移除指定的文本。被涂黑的文本会从文件中彻底移除,而不仅仅是被黑框覆盖。

API Endpoint

POST /api/v1/tools/pdf/redact-pdf

接受包含一个 PDF 文件和一个 JSON settings 字段的 multipart 表单数据。

Parameters

ParameterTypeRequiredDefaultDescription
termsstring[]Yes-要涂黑的文本字符串(1-50 个词条,每个最多 200 个字符)
caseSensitivebooleanNofalse匹配是否区分大小写

Example Request

bash
curl -X POST http://localhost:1349/api/v1/tools/pdf/redact-pdf \
  -H "Authorization: Bearer si_your-api-key" \
  -F "[email protected]" \
  -F 'settings={"terms": ["John Doe", "555-0123"], "caseSensitive": false}'

Example Response

json
{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/contract.pdf",
  "originalSize": 245000,
  "processedSize": 243000,
  "found": 7
}

Notes

  • 接受的输入格式:.pdf
  • 这是一个快速(同步)工具,直接返回结果。
  • 这会执行真正的涂黑:匹配到的文本会从 PDF 内容流中移除,而不仅仅是在视觉上遮盖。
  • 响应中的 found 字段表示涂黑了多少处。
  • 单次请求最多可涂黑 50 个词条。