yq filter

POST /api/yq-filter2 quota units per call · cache hits free

Apply jq filter expressions to YAML over HTTP. Same expression language as jq-filter — the input is YAML and the result is reformatted as YAML by default.

Same expression language as `jq-filter`, but the input is YAML and the result is reformatted as YAML by default. Set `outputFormat: "json"` to keep the raw filter output verbatim. Examples: - `.users[].name` — list all user names. - `.services | keys` — keys of a top-level mapping. - `.config.port = 9000` — return the doc with one field changed.

Inputs

Name	Type	Default	Description
filter*	string	"."	filter expression applied to the YAML-decoded value.
yaml*	file	—	YAML input. UTF-8.
outputFormat	enum (yaml \| json)	"yaml"	Output format. yaml (default) re-serializes; json passes stdout through.
rawOutput	boolean	false	-r: raw strings without quoting. Only honored when outputFormat is "json".
compact	boolean	false	-c: compact output. Only honored when outputFormat is "json".
indent	number (1…8)	2	Indent width for the YAML output. Ignored when outputFormat is "json".

Response

Modes: text, json. 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	2 units 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	`5 MiB` (base64 inflates file payloads ~33% — the limit applies to the decoded bytes).
Max response size	`10 MiB`
Timeout	10s 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 list-features example.


curl -X POST https://api.xtract.bot/api/yq-filter \
  -H "Content-Type: application/json" \
  -H "Accept: text/plain" \
  -H "X-Account-Id: $XTRACT_ACCOUNT_ID" \
  -H "X-Api-Key: $XTRACT_API_KEY" \
  -d '{
  "filter": ".service.features[]",
  "yaml": "IyBBIHNtYWxsIGNvbmZpZy1zdHlsZSBZQU1MIGRvYyDigJQgZXhlcmNpc2VzIG1hcHBpbmdzLCBzZXF1ZW5jZXMsIHNjYWxhcnMuCnNlcnZpY2U6CiAgbmFtZTogeHRyYWN0LWJvdAogIHBvcnQ6IDg3ODcKICBmZWF0dXJlczoKICAgIC0gcmF0ZS1saW1pdAogICAgLSByZXF1ZXN0LWNhY2hlCiAgICAtIG9hdXRoCmxpbWl0czoKICBtb250aGx5X3F1b3RhOiAxMDAwMAogIGJ1cnN0OiA2MApmbGFnczoKICBiZXRhOiB0cnVlCiAgbGVnYWN5OiBudWxsCg=="
}'