Skip to main content

Squillify development is paused indefinitely. Read why, and discover what this experiment achieved. Read the story

MicroSkills Reference

Gzip Compress

file.gzip_compress

ProductionBounded custom (Class B)verifiablemoderatev1.0.0
File inputFile outputNo networkTemp storage

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

Note
Compresses one managed file into one gzip member with a zeroed timestamp; original name is kept in Squillify metadata, not the gzip header.

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

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

compression

Cost & billing

Flat rate per invocation

MetercallsBillable onsuccessCost per call2 credits

File handling

Accepts file_refProduces file_refMax input2 MBMax file size25 MB

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.

LimitValueLimited by
Maximum size per input file25 MiBSkill and platform maximum
Maximum total input size25 MiBSkill maximum
Maximum number of input files1Skill maximum
Maximum generated artifact size25.0 MiBSkill maximum
Maximum number of generated files1Skill maximum

How we handle your data

Protected temp storage
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.

Read the Microskill Data Handling Policy

Input schema

FieldTypeRequiredDescription
file_refstringYesTenant-scoped source file up to 25 MiB wrapped as exactly one gzip member.
compressionLevelstringNoNamed deflate level DEFAULT, FAST, or BEST. Omit it for DEFAULT; raw integers are rejected.

Output schema

FieldTypeRequiredDescription
fileRefstringYesNew tenant-scoped gzip member. The header timestamp is zero and no original path is stored in the gzip header.
filenamestringYesPath-free download name of the gzip member, usually the source filename plus .gz.
expiresAtstringYesRFC 3339 expiry of the gzip member file_ref.
mediaTypestringYesAlways application/gzip for the single-member output.
sizeBytesintegerYesCompressed member size in bytes.
sha256stringYesSHA-256 hex digest of the gzip member bytes.
inputBytesintegerYesUncompressed source size in bytes.
compressionLevelstringYesApplied named level, one of DEFAULT, FAST, or BEST.

API contract

POST /v1/execute
curl
curl -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"}}'
Integrations
TypeScript SDK
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

CodeHTTPRetryableDescription
VALIDATION_ERROR400NoThe request payload failed schema validation.
UNAUTHORIZED401NoMissing or invalid API key.
SKILL_NOT_ACCESSIBLE403NoThe API key is not granted access to this skill.
SKILL_NOT_AVAILABLE_FOR_PLAN403NoThis skill is not included in your current plan.
PLAN_ELIGIBILITY_UNAVAILABLE503YesPlan eligibility could not be decided. Retry after backoff.
SKILL_NOT_FOUND404NoThe requested skill or version does not exist.
TENANT_RATE_LIMITED429YesRequest rate limit exceeded. Retry after backoff.
QUOTA_EXCEEDED429YesPlan quota exhausted. Retryable once the quota period resets.
EXECUTION_TIMEOUT504YesExecution exceeded the allowed time budget.
GZIP_INVALID400NoThe request payload failed this skill's input validation.
ITEM_LIMIT_EXCEEDED429NoA size, quota, rate, or time limit was exceeded.

Other limits

LimitValue
Recommended inline bytes32 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)

Request bodyjson
{
  "skillKey": "file.gzip_compress",
  "input": {
    "file_ref": "squillify://files/f-empty"
  }
}

Examples

Empty payload is a valid member

Inputjson
{
  "file_ref": "squillify://files/f-empty"
}
Expected outputjson
{
  "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"
}
Tip
An empty source still yields one gzip member

Named FAST level is accepted

Inputjson
{
  "compressionLevel": "FAST",
  "file_ref": "squillify://files/f-hello"
}
Expected outputjson
{
  "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"
}
Tip
FAST is a named level, not a raw deflate integer
  • 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

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.

Tags

gzipcompressionfile