Markdown TOC

POST /api/markdown-toc1 quota unit per call · cache hits free

Build a Markdown table of contents from your document's headings. Configurable depth, optional anchor links matching popular renderers (GitHub, etc.).

Scans a Markdown document for `#` / `##` / etc. headings and returns a table of contents — both as a nested JSON structure and as a Markdown-formatted bullet list ready to drop into your README. Options: - `maxDepth` (default 3): include headings down to this level (`1` = top-level only, `6` = everything). - `anchorStyle`: how to slugify each heading. `github` (default) matches GitHub's scheme so the links work in rendered READMEs.

Inputs

Name	Type	Default	Description
markdown*	string	—	Markdown source to scan.
maxDepth	number (1…6)	3	Deepest heading level to include.
minDepth	number (1…6)	1	Shallowest heading level to include.
slug	enum (github \| hugo)	"github"	Slug algorithm. `github` matches GitHub anchors; `hugo` matches Hugo's default rules.
skipFirstH1	boolean	false	When true, drop the first H1 (commonly the document title).

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	`4 MiB` (base64 inflates file payloads ~33% — the limit applies to the decoded bytes).
Max response size	`4 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 default-depth-3 example.


curl -X POST https://api.xtract.bot/api/markdown-toc \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-Account-Id: $XTRACT_ACCOUNT_ID" \
  -H "X-Api-Key: $XTRACT_API_KEY" \
  -d '{
  "markdown": "# Title\n\n## Setup\n\n### Install\n\n### Configure\n\n## Usage\n\n#### Edge cases (skipped)\n"
}'