Gzip Compress
file.gzip_compress
Overview
You send a file_ref up to 25 MiB. We emit one gzip member, zero the header timestamp, and never embed an original path in the gzip header. The Squillify artifact is named from the source filename (report.pdf becomes report.pdf.gz). compressionLevel is DEFAULT, FAST, or BEST — not a raw deflate integer. This is not tar, ZIP, or a multi-member archive.
A wall-clock gzip timestamp or an embedded gzip FNAME makes two compressions of the same bytes diverge. The original name is stored on the Squillify artifact instead.
Reliability
Two compressions of the same bytes and level are byte-identical. ITEM_LIMIT_EXCEEDED — trigger: the source exceeds 25 MiB; retryable: no; next: split the payload. GZIP_INVALID — trigger: the deflate write failed; retryable: no; next: inspect the source file.
Context footprint
Managed gzip fileRef plus sizes and SHA-256. A successful call costs 2 execution credits.
When to use it
When you need one interoperable gzip member with a stable digest for the same bytes and level.
When you need tar, ZIP, encryption, or concatenated members.
Scope
Non-goals
- Does not build tar or ZIP archives
- Does not emit concatenated gzip members
- Does not encrypt the payload
- Does not write the original filename into the gzip FNAME header
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 | 25 MiB | Skill and platform maximum |
| Maximum total input size | 25 MiB | Skill maximum |
| Maximum number of input files | 1 | Skill maximum |
| Maximum generated artifact size | 25.0 MiB | Skill maximum |
| Maximum number of generated files | 1 | Skill 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 |
|---|---|---|---|
| file_ref | string | Yes | Tenant-scoped source file up to 25 MiB wrapped as exactly one gzip member. |
| compressionLevel | string | No | Named deflate level DEFAULT, FAST, or BEST. Omit it for DEFAULT; raw integers are rejected. |
Output schema
| Field | Type | Required | Description |
|---|---|---|---|
| fileRef | string | Yes | New tenant-scoped gzip member. The header timestamp is zero and no original path is stored in the gzip header. |
| filename | string | Yes | Path-free download name of the gzip member, usually the source filename plus .gz. |
| expiresAt | string | Yes | RFC 3339 expiry of the gzip member file_ref. |
| mediaType | string | Yes | Always application/gzip for the single-member output. |
| sizeBytes | integer | Yes | Compressed member size in bytes. |
| sha256 | string | Yes | SHA-256 hex digest of the gzip member bytes. |
| inputBytes | integer | Yes | Uncompressed source size in bytes. |
| compressionLevel | string | Yes | Applied named level, one of DEFAULT, FAST, or BEST. |
API contract
POST /v1/executecurl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"file.gzip_compress","input":{"file_ref":"squillify://files/f-hello"}}'import { Squillify } from "@squillify/sdk";
const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });
const { output } = await sq.execute("file.gzip_compress", {"file_ref":"squillify://files/f-empty"});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. |
| GZIP_INVALID | 400 | No | The request payload failed this skill's input validation. |
| ITEM_LIMIT_EXCEEDED | 429 | No | A size, quota, rate, or time limit was exceeded. |
Other limits
| Limit | Value |
|---|---|
| Recommended inline bytes | 32 KiB |
Limitations
- Does not build tar or ZIP archives
- Does not emit concatenated gzip members
- Does not encrypt the payload
- Does not write the original filename into the gzip FNAME header
- Packaging a directory tree
- Multi-member gzip streams
How to call
POST /v1/execute (requires authentication)
{
"skillKey": "file.gzip_compress",
"input": {
"file_ref": "squillify://files/f-empty"
}
}Examples
Empty payload is a valid member
{
"file_ref": "squillify://files/f-empty"
}{
"filename": "payload.gz",
"expiresAt": "2026-08-27T00:10:00Z",
"sizeBytes": 20,
"sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
"mediaType": "application/gzip",
"compressionLevel": "DEFAULT",
"inputBytes": 0,
"fileRef": "squillify://files/f-generated"
}Named FAST level is accepted
{
"compressionLevel": "FAST",
"file_ref": "squillify://files/f-hello"
}{
"filename": "hello.txt.gz",
"expiresAt": "2026-08-27T00:10:00Z",
"sizeBytes": 25,
"sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
"mediaType": "application/gzip",
"compressionLevel": "FAST",
"inputBytes": 5,
"fileRef": "squillify://files/f-generated"
}Recommended use cases
- Wrap a payload for a later single-member gunzip
- Produce a byte-identical gzip across retries
Avoid for
- Packaging a directory tree
- Multi-member gzip streams
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.