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.
46 lines
1.1 KiB
Markdown
46 lines
1.1 KiB
Markdown
---
|
|
description: Remove password protection from a PDF.
|
|
---
|
|
|
|
# Unlock PDF
|
|
|
|
Remove password protection from an encrypted PDF by providing the correct password.
|
|
|
|
## API Endpoint
|
|
|
|
`POST /api/v1/tools/unlock-pdf`
|
|
|
|
Accepts multipart form data with a PDF file and a JSON `settings` field.
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Required | Default | Description |
|
|
|-----------|------|----------|---------|-------------|
|
|
| password | string | Yes | - | Password to decrypt the PDF (1-256 characters) |
|
|
|
|
## Example Request
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/unlock-pdf \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@document.pdf" \
|
|
-F 'settings={"password": "s3cret"}'
|
|
```
|
|
|
|
## Example Response
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/document.pdf",
|
|
"originalSize": 2500000,
|
|
"processedSize": 2450000
|
|
}
|
|
```
|
|
|
|
## Notes
|
|
|
|
- The correct password must be provided; an incorrect password returns a 400 error.
|
|
- Either the user password or the owner password will work for decryption.
|
|
- Passwords are redacted from audit logs.
|