mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtterandGitHub
ecc0a45f0e
* fix(docs): keep gray-matter on js-yaml 3 so the docs site builds The js-yaml >=4.2.0 override from #257 forced js-yaml 4 onto gray-matter (used by vitepress and vitepress-plugin-llms), which calls the removed yaml.safeLoad and broke `vitepress build`. Scope a gray-matter>js-yaml ^3.14.1 override so gray-matter keeps the v3 API (build-time, trusted frontmatter only) while app code stays on js-yaml 4.2.0+. * docs: add per-tool reference pages for all 157 tools, with a modality sidebar Generate /tools/<id> pages for the 104 tools that lacked one (video 29, audio 17, document 36, data 10, and 12 newer image tools), matching the existing page format (API endpoint, parameters from the OpenAPI spec, curl example, response, notes). Async/AI tools document the 202+SSE flow and feature-bundle requirement. Sidebar: add Video / Audio / PDF & Documents / Data groups with per-tool links, fold the 12 new image tools into the existing image categories, and replace the placeholder rest.md-anchor group. Docs site builds cleanly (157 pages, no dead links).
56 lines
1.7 KiB
Markdown
56 lines
1.7 KiB
Markdown
---
|
|
description: Add a text watermark to every page of a PDF.
|
|
---
|
|
|
|
# Watermark PDF
|
|
|
|
Stamp a text watermark on every page of a PDF with configurable position, size, opacity, and rotation.
|
|
|
|
## API Endpoint
|
|
|
|
`POST /api/v1/tools/watermark-pdf`
|
|
|
|
Accepts multipart form data with a PDF file and a JSON `settings` field.
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Required | Default | Description |
|
|
|-----------|------|----------|---------|-------------|
|
|
| text | string | Yes | - | Watermark text (1-200 characters) |
|
|
| position | string | No | `"c"` | Placement on the page: `tl`, `tc`, `tr`, `l`, `c`, `r`, `bl`, `bc`, `br` |
|
|
| fontSize | integer | No | `48` | Font size in points (6-72) |
|
|
| opacity | number | No | `0.3` | Watermark opacity (0.05-1) |
|
|
| rotation | number | No | `45` | Rotation angle in degrees (-180 to 180) |
|
|
|
|
### Position Values
|
|
|
|
- `tl` top-left, `tc` top-center, `tr` top-right
|
|
- `l` center-left, `c` center, `r` center-right
|
|
- `bl` bottom-left, `bc` bottom-center, `br` bottom-right
|
|
|
|
## Example Request
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/watermark-pdf \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@document.pdf" \
|
|
-F 'settings={"text": "CONFIDENTIAL", "position": "c", "opacity": 0.2, "rotation": 45}'
|
|
```
|
|
|
|
## Example Response
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/document.pdf",
|
|
"originalSize": 2450000,
|
|
"processedSize": 2500000
|
|
}
|
|
```
|
|
|
|
## Notes
|
|
|
|
- The watermark is rendered as a text overlay on each page.
|
|
- The same watermark text, position, and style are applied uniformly to all pages.
|
|
- Use lower opacity values (0.1-0.3) for subtle watermarks that do not obscure content.
|