mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtter
d24e244af4
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).
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/pdf/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/pdf/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.
|