mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
docs: organize tool pages by modality under /tools/<modality>/
Move all 157 tool pages into image/video/audio/pdf/data subfolders so URLs read /tools/<modality>/<id> (e.g. /tools/image/crop). Nest the image sub-categories under an Image group in the sidebar so the nav reads by modality. Add public/_redirects (301, clean + .html forms) mapping every old flat /tools/<id> URL to its new path so inbound links keep working. Rewrite all internal /tools links. Verified with a clean docs build (no dead links).
This commit is contained in:
@@ -0,0 +1,59 @@
|
||||
---
|
||||
description: Shrink PDF file size by compressing embedded images.
|
||||
---
|
||||
|
||||
# Compress PDF
|
||||
|
||||
Reduce PDF file size by downsampling embedded images. Choose between a quality slider or a target file size.
|
||||
|
||||
## API Endpoint
|
||||
|
||||
`POST /api/v1/tools/pdf/compress-pdf`
|
||||
|
||||
Accepts multipart form data with a PDF file and a JSON `settings` field.
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Required | Default | Description |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| mode | string | No | `"quality"` | Compression mode: `quality` or `targetSize` |
|
||||
| quality | integer | No | - | Compression quality, 1-100 (higher = less compression). Used in `quality` mode |
|
||||
| targetSizeKb | number | No | - | Target file size in kilobytes. Used in `targetSize` mode |
|
||||
|
||||
## Example Request
|
||||
|
||||
Compress by quality:
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/pdf/compress-pdf \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@document.pdf" \
|
||||
-F 'settings={"mode": "quality", "quality": 60}'
|
||||
```
|
||||
|
||||
Compress to a target size:
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/pdf/compress-pdf \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@document.pdf" \
|
||||
-F 'settings={"mode": "targetSize", "targetSizeKb": 500}'
|
||||
```
|
||||
|
||||
## Example Response
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/document.pdf",
|
||||
"originalSize": 5200000,
|
||||
"processedSize": 1800000
|
||||
}
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
- In `quality` mode, lower values produce smaller files with more image degradation.
|
||||
- In `targetSize` mode, a binary search finds the highest DPI that fits the requested size.
|
||||
- If compression would enlarge the file, the original bytes are returned unchanged.
|
||||
- Text and vector content are not affected; only embedded raster images are downsampled.
|
||||
Reference in New Issue
Block a user