Hex encode

POST /api/hex-encode1 quota unit per call · cache hits free

Encode bytes as hex (lowercase, uppercase, with optional `0x` prefix or `:` separators). The classic format for inspecting bytes.

Encodes any bytes as a hex string. Options: - `uppercase` (default false): emit `ABCDEF` rather than `abcdef`. - `prefix` (default false): prepend `0x` — common in low-level programming and protocol traces. - `separator`: a string to insert between every byte. Pass `:` for MAC-address-style output, ` ` for space-separated.

Inputs

Name	Type	Default	Description
data*	file	—	Bytes to encode (base64-encoded by the playground).
case	enum (lower \| upper)	"lower"	Case of the hex digits a-f.
separator	string	""	Optional separator inserted between every byte.
prefix	boolean	false	Prepend '0x' to the result.

Response

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

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	`8 MiB` (base64 inflates file payloads ~33% — the limit applies to the decoded bytes).
Max response size	`32 MiB`
Timeout	5s 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 hello-lower example.

# Download or substitute the example input:
#   curl -O https://xtract.bot/examples/hex-encode/hello.txt
DATA=$(base64 -w0 < hello.txt)

curl -X POST https://api.xtract.bot/api/hex-encode \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-Account-Id: $XTRACT_ACCOUNT_ID" \
  -H "X-Api-Key: $XTRACT_API_KEY" \
  -d '{
  "case": "lower",
  "separator": "",
  "prefix": false,
  "data": "'"$DATA"'"
}'