mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtterandGitHub
00b651c9f8
Shared Claude Code translation pipeline (scripts/i18n, no API key) plus Astro/VitePress/Scalar i18n wiring. Landing and API reference translated into all 20 languages; docs i18n wiring + English source anchors. The translated docs markdown (apps/docs/<locale>/**, 3,620 files) follows in a companion PR because it exceeds GitHub's per-PR CI file limit.
44 lines
1.4 KiB
Markdown
44 lines
1.4 KiB
Markdown
---
|
|
description: Safely extract files from a ZIP archive with bomb protection.
|
|
---
|
|
|
|
# Extract ZIP {#extract-zip}
|
|
|
|
Safely extract files from a ZIP archive. Single-file archives return the contained file directly; multi-file archives return a flat ZIP with the extracted contents.
|
|
|
|
## API Endpoint {#api-endpoint}
|
|
|
|
`POST /api/v1/tools/files/extract-zip`
|
|
|
|
Accepts multipart form data with a ZIP file. No settings field is required.
|
|
|
|
## Parameters {#parameters}
|
|
|
|
This tool has no configurable parameters. Upload a `.zip` file to extract.
|
|
|
|
## Example Request {#example-request}
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/files/extract-zip \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@archive.zip"
|
|
```
|
|
|
|
## Example Response {#example-response}
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/archive_extracted.zip",
|
|
"originalSize": 2800000,
|
|
"processedSize": 3500000
|
|
}
|
|
```
|
|
|
|
## Notes {#notes}
|
|
|
|
- Only `.zip` files are accepted as input.
|
|
- If the archive contains a single file, that file is returned directly (not wrapped in a ZIP).
|
|
- If the archive contains multiple files, a flat ZIP is returned with all files extracted to the root level (nested directory structure is flattened).
|
|
- Built-in bomb protection rejects archives with excessive compression ratios or file counts to prevent resource exhaustion.
|