Skip to main content
POST
/
v1
/
document
/
pdf-watermark
{
  "input": "https://example.com/document.pdf",
  "text": "CONFIDENTIAL",
  "opacity": 0.3
}

curl -X POST https://api.ringbee.dev/v1/document/pdf-watermark \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@document.pdf" \
  -F "text=CONFIDENTIAL" \
  -F "opacity=0.3"

{
  "id": "job_abc123",
  "status": "pending"
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}
{
  "input": "https://example.com/document.pdf",
  "text": "CONFIDENTIAL",
  "opacity": 0.3
}

curl -X POST https://api.ringbee.dev/v1/document/pdf-watermark \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@document.pdf" \
  -F "text=CONFIDENTIAL" \
  -F "opacity=0.3"
ParamTypeDescription
textstringWatermark text to overlay on each page
opacitynumberWatermark opacity from 0 (invisible) to 1 (fully opaque)

Authorizations

​
X-API-Key
string
header
required

Body

​
input
string
required

Input file URL

​
text
string

Watermark text to overlay on each page

​
opacity
number

Watermark opacity from 0 (invisible) to 1 (fully opaque)

​
webhook_url
string

URL to receive job completion notification

Response

Job accepted

​
id
string
Example:

"job_abc123"

​
status
enum<string>
Available options:
pending,
processing,
completed,
failed,
cancelled
Example:

"pending"