Files
SnapOtter/apps/docs/tools/files/create-zip.md
T
SnapOtterandGitHub 607c24895b Improve docs search UX, dash cleanup, and colored modality tool icons (#338)
* feat(docs): improve search UX

- Hide the 'Search by Pagefind' branding in the search dialog footer
- Replace the 'No results found.' message shown before any query with a
  friendly hint (detected via empty-input :placeholder-shown state)
- Tune placeholder, empty-state, and results-heading copy; show a few
  sub-section matches per result (pageResultCount)

* docs: replace double-dash em-dash substitute with single dash

Swept prose ' -- ' to ' - ' and numeric ranges (e.g. 2--20 to 2-20)
across the documentation. CLI flags and code blocks left untouched.

* fix(landing): show colored category icons on modality tool pages

The /tools/<modality>/ pages rendered bare name+description cards with no
icon or color. Port the colored, category-tinted icon card from /tools/
so modality pages match the main catalog (icon, tint, 'Learn more').
2026-06-24 12:06:31 +08:00

46 lines
1.1 KiB
Markdown

---
description: Bundle multiple files into a single ZIP archive.
---
# Create ZIP
Bundle multiple files of any type into a single ZIP archive. Duplicate filenames are automatically deduplicated.
## API Endpoint
`POST /api/v1/tools/files/create-zip`
Accepts multipart form data with two or more files. No settings field is required.
## Parameters
This tool has no configurable parameters. Upload 2-50 files of any type to bundle.
## Example Request
```bash
curl -X POST http://localhost:1349/api/v1/tools/files/create-zip \
-H "Authorization: Bearer si_your-api-key" \
-F "file=@report.pdf" \
-F "file=@data.csv" \
-F "file=@photo.jpg"
```
## Example Response
```json
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/archive.zip",
"originalSize": 3500000,
"processedSize": 2800000
}
```
## Notes
- Requires between 2 and 50 input files.
- Any file type is accepted; there are no restrictions on input format.
- If multiple files share the same name, they are automatically deduplicated with numeric suffixes.
- The output archive uses standard ZIP compression (deflate).