{"uid":"cap_LExjFhXRsXg3z1B9EUkfi","slug":"markdown-document-outline-extractor-aed926d9","name":"Markdown Document Outline Extractor","description":"Outline a Markdown document: front matter, headings with anchors, links, images, code blocks with language, and problems.","url":"https://markup-tools.x402tookit.com/markdown-outline?utm_source=zero.xyz","method":"GET","headers":{},"bodySchema":{"type":"object","$schema":"https://json-schema.org/draft/2020-12/schema","required":["input"],"properties":{"input":{"type":"object","required":["type","method"],"properties":{"type":{"type":"string","const":"http"},"method":{"enum":["GET"],"type":"string"},"queryParams":{"type":"object","required":["markdown"],"properties":{"markdown":{"type":"string","description":"Markdown, up to 20000 characters (longer is refused with 400)"}}}},"additionalProperties":false},"output":{"type":"object","required":["type"],"properties":{"type":{"type":"string"},"example":{"type":"object","properties":{"asOf":{"type":["null","string"]},"links":{"type":["array","null"],"items":{"type":"object","properties":{"url":{"type":["null","string"]},"kind":{"type":["null","string"]},"line":{"type":["null","number"]},"text":{"type":["null","string"]},"title":{}}}},"images":{"type":["array","null"]},"issues":{"type":["array","null"],"items":{"type":"string"}},"source":{"type":["null","string"]},"reasons":{"type":["array","null"],"items":{"type":"string"}},"summary":{"type":["null","string"]},"verdict":{"type":["null","string"]},"degraded":{"type":["boolean","null"]},"headings":{"type":["array","null"],"items":{"type":"object","properties":{"line":{"type":["null","number"]},"text":{"type":["null","string"]},"level":{"type":["null","number"]},"anchor":{"type":["null","string"]}}}},"listCount":{"type":["null","number"]},"codeBlocks":{"type":["array","null"],"items":{"type":"object","properties":{"line":{"type":["null","number"]},"lines":{"type":["null","number"]},"closed":{"type":["boolean","null"]},"fenced":{"type":["boolean","null"]},"language":{"type":["null","string"]}}}},"disclaimer":{"type":["null","string"]},"notChecked":{"type":["array","null"],"items":{"type":"string"}},"tableCount":{"type":["null","number"]},"frontMatter":{"type":["null","object"],"properties":{"keys":{"type":["array","null"],"items":{"type":"string"}},"lines":{"type":["null","number"]},"format":{"type":["null","string"]}}},"paragraphCount":{"type":["null","number"]},"approxWordCount":{"type":["null","number"]}}}}}}},"responseSchema":null,"example":null,"exampleRequest":null,"tags":["x402"],"displayCostAmount":"0.02","displayCostAsset":"USDC","priceDynamic":false,"priceHint":null,"priceStatus":"priced","priceSource":"probe","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"unknown","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"static","summary":"$0.02/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.02","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.02","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_Oj2DUYChtk9NAcvWp1tVF","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"0.02","costPer":"request","priority":0,"asset":"0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913","unit":"request","depositMicros":null,"planRef":null}],"brandName":null,"brandSlug":null,"brandBaseUrl":null,"brandDocsUrl":null,"whatItDoes":"Parses a Markdown document and returns a structured outline including front matter, headings with anchors, links, images, code blocks with language tags, and detected problems.","exampleAgentPrompt":"Can you outline the structure of this Markdown document for me — I need all the headings with their anchor links, any links and images, code blocks with their languages, and a list of any problems detected: [paste markdown here]","exampleUseCases":[{"title":"README structure audit","prompt":"I've got this README.md file and I want to know all the headings and their anchor slugs, what links and images are in it, and whether there are any problems like unclosed code blocks. Can you parse it and give me a full outline?"},{"title":"Documentation site nav generation","prompt":"Here's the raw Markdown for our docs page — can you extract all the headings with their anchors and line numbers so I can auto-generate a table of contents for the sidebar?"},{"title":"Markdown quality check before publish","prompt":"Before I publish this blog post written in Markdown, can you check it for issues — find any broken code fences, list the code blocks and their languages, pull out all the links, and flag any problems you spot?"}],"resultDescription":"Returns a structured JSON object containing: parsed front matter (keys, format, line count), an array of headings (text, level, anchor, line number), an array of links (URL, text, kind, line number), an array of images, an array of code blocks (language, line number, line count, fenced/closed flags), list count, table count, a summary, and an array of detected issues or problems in the document.","failureModes":["Markdown input exceeds 20,000 characters — returns 400 error","Missing required 'markdown' query parameter — returns 400 error","Malformed or non-Markdown content may produce empty or minimal structured output","Payment not provided or insufficient — returns 402 Payment Required","Service degraded flag may indicate partial results"],"whenToPreferThis":"Use this endpoint when you need a fast, structured outline of a Markdown document including headings with anchor IDs, links, images, code blocks with language detection, and problem flagging — especially for documentation audits, TOC generation, or pre-publish quality checks. Prefer this over HTML-based endpoints when your source is raw Markdown rather than rendered HTML.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-11-04T13:14:56.543Z","isFirstParty":false,"canonicalSlug":"markdown-document-outline-extractor-aed926d9"}