mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtter
8532f3227b
Reconcile every tool page's parameters, defaults, and response shape against the tool's Zod settings schema and executionHint in code. Notable fixes: color-palette (add count + format params, hex output, median-cut algorithm), favicon (add 5 params, was documented as having none), qr-generate (add logoDataUri), convert (add ppm/eps/tga formats), video-loudnorm (-16 LUFS not -14), smart-crop (async 202 not sync 200), images-to-video (1080x1080 square), and several output-filename and behavior-note corrections. Also normalize API endpoint paths to /api/v1/tools/<id> (no modality segment) and standardize curl examples on the Docker API port 1349. Verified with a clean docs build.
51 lines
1.2 KiB
Markdown
51 lines
1.2 KiB
Markdown
---
|
|
description: Combine multiple PDFs into a single document.
|
|
---
|
|
|
|
# Merge PDFs
|
|
|
|
Combine two or more PDF files into a single document, preserving the page order of each input file.
|
|
|
|
## API Endpoint
|
|
|
|
`POST /api/v1/tools/merge-pdf`
|
|
|
|
Accepts multipart form data with two or more PDF files. No `settings` field is required.
|
|
|
|
## Parameters
|
|
|
|
This tool has no settings parameters. Simply upload two or more PDF files.
|
|
|
|
| Constraint | Value |
|
|
|------------|-------|
|
|
| Minimum files | 2 |
|
|
| Maximum files | 20 |
|
|
|
|
## Example Request
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/merge-pdf \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@document1.pdf" \
|
|
-F "file=@document2.pdf" \
|
|
-F "file=@document3.pdf"
|
|
```
|
|
|
|
## Example Response
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/merged.pdf",
|
|
"originalSize": 4500000,
|
|
"processedSize": 4200000
|
|
}
|
|
```
|
|
|
|
## Notes
|
|
|
|
- Files are merged in the order they are uploaded.
|
|
- At least two PDF files are required; the request will fail with a 400 error if fewer are provided.
|
|
- The maximum number of input files is 20.
|
|
- Encrypted PDFs must be unlocked before merging.
|