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.
73 lines
2.4 KiB
Markdown
73 lines
2.4 KiB
Markdown
---
|
|
description: Rename multiple files using a pattern template and download as ZIP.
|
|
---
|
|
|
|
# Bulk Rename
|
|
|
|
Rename multiple files using a pattern template with placeholders for index, padded index, and original filename. Returns a ZIP archive containing all renamed files.
|
|
|
|
## API Endpoint
|
|
|
|
`POST /api/v1/tools/bulk-rename`
|
|
|
|
Accepts multipart form data with multiple files and a JSON `settings` field.
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Required | Default | Description |
|
|
|-----------|------|----------|---------|-------------|
|
|
| pattern | string | No | `"image-{{index}}"` | Naming pattern with placeholders (max 1000 characters) |
|
|
| startIndex | number | No | `1` | Starting index number |
|
|
|
|
### Pattern Placeholders
|
|
|
|
| Placeholder | Description | Example |
|
|
|-------------|-------------|---------|
|
|
| `{{index}}` | Sequential number starting from `startIndex` | `1`, `2`, `3` |
|
|
| `{{padded}}` | Zero-padded sequential number | `01`, `02`, `03` |
|
|
| `{{original}}` | Original filename without extension | `photo`, `IMG_001` |
|
|
|
|
The original file extension is always preserved.
|
|
|
|
## Example Request
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/bulk-rename \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@photo1.jpg" \
|
|
-F "file=@photo2.jpg" \
|
|
-F "file=@photo3.jpg" \
|
|
-F 'settings={"pattern": "vacation-{{padded}}", "startIndex": 1}'
|
|
```
|
|
|
|
This produces: `vacation-1.jpg`, `vacation-2.jpg`, `vacation-3.jpg`
|
|
|
|
Using original filename:
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/bulk-rename \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@IMG_001.jpg" \
|
|
-F "file=@IMG_002.jpg" \
|
|
-F 'settings={"pattern": "2024-trip-{{original}}-{{index}}"}'
|
|
```
|
|
|
|
This produces: `2024-trip-IMG_001-1.jpg`, `2024-trip-IMG_002-2.jpg`
|
|
|
|
## Example Response
|
|
|
|
The response is a ZIP file streamed directly (not a JSON response). The response headers are:
|
|
|
|
```
|
|
Content-Type: application/zip
|
|
Content-Disposition: attachment; filename="renamed-a1b2c3d4.zip"
|
|
```
|
|
|
|
## Notes
|
|
|
|
- This tool does not process images. It only renames files and packages them into a ZIP archive.
|
|
- The zero-padding width for `{{padded}}` is determined automatically based on the total number of files (e.g. 100 files would use 3-digit padding: `001`, `002`, etc.).
|
|
- File extensions are preserved from the original filenames.
|
|
- Filenames are sanitized to remove unsafe characters.
|
|
- At least one file must be provided.
|