Extract ZIP Manifest
file.extract_zip_manifest
Overview
You pass a managed ZIP reference and we read its central directory to list every entry (path, directory flag, symlink flag, compressed and uncompressed size, CRC-32, compression ratio) without extracting bodies. We flag zip-slip paths, symlinks, and suspicious compression ratios so you can vet an archive before extraction. Do not use this when you need the extracted file contents.
Inspecting an archive before extraction is safer and cheaper than unpacking everything.
Reliability
VERIFIABLE and deterministic for a fixed archive. Domain error (not retryable — reject or re-upload the archive): ARCHIVE_MALFORMED (bytes are not a readable ZIP or the central directory cannot be parsed). Input validation: inaccessible fileRef; archive exceeds 200 MiB; maxEntries out of range.
Context footprint
Returns entries, aggregate summary, and optional per-entry hashes. A successful call costs 5 execution credits.
When to use it
To preview contents and detect zip-slip or bomb risks before extraction.
When you need the extracted file bytes.
Scope
Non-goals
- Does not extract file bodies
- Does not decrypt password-protected archives
- Does not modify the archive
Properties
Capabilities
Cost & billing
Flat rate per invocation
File handling
File limits
Constraints this skill applies to your input and generated files. The “Limited by” column shows the static source of each cap; none of these can be raised by upgrading your plan.
| Limit | Value | Limited by |
|---|---|---|
| Maximum size per input file | 50 MiB | Platform maximum |
How we handle your data
What this means
This skill may temporarily store files or intermediate data only to complete execution. Temporary data is protected and automatically deleted.
Squillify guarantees
- Runs inside Squillify
- This skill runs inside Squillify.
- Payloads are not sent to an external service by this skill.
- Temporary execution only storage
- Squillify does not permanently store submitted payloads.
- Telemetry records metadata only, not submitted content.
- Submitted payloads are not used for training.
- Submitted payloads are not reviewed by humans.
- This skill does not target sensitive data.
- The response may contain submitted or transformed content.
Your responsibility
Squillify does not determine whether submitted content is sensitive. Your application is responsible for deciding what data it is allowed to submit. Your application is responsible for securing the response.
Input schema
| Field | Type | Required | Description |
|---|---|---|---|
| fileRef | string | Yes | Managed ZIP reference resolved inside the current tenant, read up to 200 MiB. |
| includeHashes | boolean | No | Whether per-entry SHA-256 is computed by reading bodies; omit it for false. |
| maxEntries | integer | No | Maximum entries to list; omit it for 10000. |
| detectUnsafePaths | boolean | No | Whether zip-slip paths are flagged; omit it for true. |
Output schema
| Field | Type | Required | Description |
|---|---|---|---|
| ok | boolean | Yes | Always true on success. |
| entries | array | Yes | Bounded array of 0 through 1000000 closed central-directory entries. |
| summary | object | Yes | Closed archive totals including unsafe-path count and truncation. |
| metadata | object | No | Closed manifest metadata echoing includeHashes and the archive reader. |
API contract
POST /v1/executecurl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"file.extract_zip_manifest","input":{"fileRef":"squillify://files/f-1"}}'import { Squillify } from "@squillify/sdk";
const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });
const { output } = await sq.execute("file.extract_zip_manifest", {"fileRef":"squillify://files/f-1"});Errors
| Code | HTTP | Retryable | Description |
|---|---|---|---|
| VALIDATION_ERROR | 400 | No | The request payload failed schema validation. |
| UNAUTHORIZED | 401 | No | Missing or invalid API key. |
| SKILL_NOT_ACCESSIBLE | 403 | No | The API key is not granted access to this skill. |
| SKILL_NOT_AVAILABLE_FOR_PLAN | 403 | No | This skill is not included in your current plan. |
| PLAN_ELIGIBILITY_UNAVAILABLE | 503 | Yes | Plan eligibility could not be decided. Retry after backoff. |
| SKILL_NOT_FOUND | 404 | No | The requested skill or version does not exist. |
| TENANT_RATE_LIMITED | 429 | Yes | Request rate limit exceeded. Retry after backoff. |
| QUOTA_EXCEEDED | 429 | Yes | Plan quota exhausted. Retryable once the quota period resets. |
| EXECUTION_TIMEOUT | 504 | Yes | Execution exceeded the allowed time budget. |
| ARCHIVE_MALFORMED | 400 | No | The request payload failed this skill's input validation. |
Other limits
| Limit | Value |
|---|---|
| Recommended inline bytes | 32 KiB |
Limitations
- Does not extract file bodies
- Does not decrypt password-protected archives
- Does not modify the archive
- Actually extracting files (use file.safe_extract_archive)
- Processing encrypted ZIP archives
How to call
POST /v1/execute (requires authentication)
{
"skillKey": "file.extract_zip_manifest",
"input": {
"fileRef": "squillify://files/f-1"
}
}Examples
Single-file ZIP with default safety checks
{
"fileRef": "squillify://files/f-1"
}{
"ok": true,
"summary": {
"maxCompressionRatio": 1.67,
"directories": 0,
"entryCount": 1,
"totalUncompressedBytes": 20,
"truncated": false,
"symlinks": 0,
"unsafePathCount": 0,
"totalCompressedBytes": 12
},
"metadata": {
"engine": "commons-compress",
"includeHashes": false
},
"entries": [
{
"uncompressedSize": 20,
"unsafePath": false,
"directory": false,
"symlink": false,
"compressedSize": 12,
"crc32": "1a2b3c4d",
"path": "a/one.txt",
"compressionRatio": 1.67
}
]
}Cap the entry list for a large archive preview
{
"fileRef": "squillify://files/f-large",
"maxEntries": 100
}{
"ok": true,
"summary": {
"maxCompressionRatio": 1.67,
"directories": 0,
"entryCount": 1,
"totalUncompressedBytes": 20,
"truncated": true,
"symlinks": 0,
"unsafePathCount": 0,
"totalCompressedBytes": 12
},
"metadata": {
"engine": "commons-compress",
"includeHashes": false
},
"entries": [
{
"uncompressedSize": 20,
"unsafePath": false,
"directory": false,
"symlink": false,
"compressedSize": 12,
"crc32": "1a2b3c4d",
"path": "a/one.txt",
"compressionRatio": 1.67
}
]
}Recommended use cases
- Preview archive contents before extraction
- Detect zip-slip paths or symlink entries early
- Audit compression ratios for zip-bomb risk
Avoid for
- Actually extracting files (use file.safe_extract_archive)
- Processing encrypted ZIP archives
Related skills
Composable with
Safety & privacy
- Runs without calling any external service.
- Your payloads are never stored permanently.
- Telemetry captures metadata only — never your payload contents.
- We never train models on your payloads.
- No human reviews your payloads.