Excel to CSV

POST /api/excel-to-csv1 quota unit per call · cache hits free

Convert an Excel sheet to CSV. Pick a specific sheet by name or index. Cell values are stringified; formulas are evaluated to their cached result.

Reads an Excel workbook (.xlsx or legacy .xls) and returns one sheet as CSV. Options: - `sheet`: pick a sheet by 0-based index (`0`, `1`, …) or by name (`Summary`, `Data`). Default is the first sheet. - `delimiter`: output separator (default `,`; pass `\t` for TSV). Cell values are stringified using their displayed format; formulas are evaluated to their cached result (Excel saves this when the file is closed).

Inputs

Name	Type	Default	Description
workbook*	file	—	Excel workbook bytes (XLSX, XLSB, XLS, or ODS).
sheet	string	—	Sheet name (case-sensitive) or 1-indexed sheet number as a string. Defaults to the first sheet.
delimiter	string	","	Field delimiter (default `,`).
rawValues	boolean	false	When true, return raw cell values; when false (default), dates are formatted as ISO strings.

Response

Modes: 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	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	`50 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 first-sheet example.

# Download or substitute the example input:
#   curl -O https://xtract.bot/examples/excel-to-csv/sample.xlsx
WORKBOOK=$(base64 -w0 < sample.xlsx)

curl -X POST https://api.xtract.bot/api/excel-to-csv \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-Account-Id: $XTRACT_ACCOUNT_ID" \
  -H "X-Api-Key: $XTRACT_API_KEY" \
  -d '{
  "workbook": "'"$WORKBOOK"'"
}'