Create ZIP

POST /api/zip-create1 quota unit per call · cache hits free

Pack one or more files into a ZIP archive over HTTP. Optional comma-separated filenames, configurable compression level. Returns the archive as binary or base64.

Packs the supplied files into a single ZIP archive and returns it. Options: - `files`: one or more files. Order matters — `names` is matched by index. - `names` (optional): comma-separated filenames, indexed against `files`. If missing or short, unspecified entries fall back to `file-0.bin`, `file-1.bin`, and so on. - `level` (optional, default 6): compression level. `0` stores the files without compression (fastest, largest); `9` is max compression. Output is the ZIP bytes (Content-Type `application/zip`) or, if the caller prefers, a JSON envelope with the archive as base64.

Inputs

Name	Type	Default	Description
files*	file	—	One or more files to include. Bytes are taken in the order supplied; pair with `names` for stable filenames.
names	string	—	Comma-separated filenames, parallel-indexed with `files`. Missing entries fall back to `file-{index}.bin`.
level	number (0…9)	6	DEFLATE compression level (0 = stored / no compression, 9 = max).

Response

Modes: binary, stream, json. Cache: yes (24h TTL).

Large outputs stream: responses over the 4 MiB cache limit are piped through as they are produced instead of buffered. They carry x-cache-skip: size and are never cached — identical follow-up calls recompute.

Every response carries x-cache (HIT / MISS / BYPASS), x-cache-signature (stable across identical inputs), and the rate-limit headers listed below.

Quota & limits

Cost per call	1 unit against the 10,000-unit monthly quota. Cache hits are free — only cache misses decrement.
Burst limit	200 requests per rolling minute, shared across all tools.
Max request size	`25 MiB` (base64 inflates file payloads ~33% — the limit applies to the decoded bytes).
Max response size	`25 MiB`
Timeout	30s wall clock.
Rate-limit headers	`X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Burst-Limit` on every response; `X-Quota-Warning` once 80% of the monthly quota is spent; `Retry-After` on 429s.

Errors

Errors are JSON with an error string; schema failures add a details object (Zod's flattened field errors).

Status	When	Body
400	Input fails the tool's schema (wrong type, missing required field, malformed base64) or the file bytes can't be parsed as the expected format.	{ "error": "invalid inputs", "details": { "fieldErrors": { … } } }
401	Missing or invalid X-Api-Key / X-Account-Id headers (or no session when called from the browser).	{ "error": "unauthorized" }
404	Unknown tool id, or calling /api/* on the website hostname instead of api.xtract.bot.	{ "error": "not found" }
413	Request body over the tool's max request size, or an image header declaring more megapixels than the tool's pixel budget.	{ "error": "…exceeds maxRequestBytes…" }
415	Content-Type isn't application/json on the json-body transport.	{ "error": "unsupported content-type; expected application/json" }
429	Monthly quota or the 200/min burst limit exhausted. Check Retry-After and the X-RateLimit-* headers.	{ "error": "monthly quota exceeded", "monthRemaining": 0, … }
5xx	Conversion engine failure. Safe to retry; if it persists, the input is hitting a bug — please report it.	{ "error": "…" }

Code samples

Built from the two-files example.

# Download or substitute the example input:
#   curl -O https://xtract.bot/examples/zip-create/greetings.txt
FILES_0_=$(base64 -w0 < greetings.txt)
# Download or substitute the example input:
#   curl -O https://xtract.bot/examples/zip-create/readme.md
FILES_1_=$(base64 -w0 < readme.md)

curl -X POST https://api.xtract.bot/api/zip-create \
  -H "Content-Type: application/json" \
  -H "Accept: application/octet-stream" \
  -H "X-Account-Id: $XTRACT_ACCOUNT_ID" \
  -H "X-Api-Key: $XTRACT_API_KEY" \
  -d '{
  "level": 6,
  "names": "greetings.txt,readme.md",
  "files[0]": "__BASE64_FILES_0___",
  "files[1]": "__BASE64_FILES_1___"
}'