---
title: "Render Markdown to HTML, build a TOC and compute statistics."
method: POST
path: "/api/v1/markdown"
tags: ["Web Tools"]
---

# Render Markdown to HTML, build a TOC and compute statistics.

`POST /api/v1/markdown`

## Request

- Base URL: `https://programmes.net`
- URL: `https://programmes.net/api/v1/markdown`
- Auth: none declared

Markdown Preview. Operations: `render` — Render GitHub-flavored Markdown to sanitized HTML. `toc` — Extract a table of contents from Markdown headers. `stats` — Compute document statistics for Markdown/plain text.

## Request body

- union
  - MarkdownRender: Render GitHub-flavored Markdown to sanitized HTML.
    - `operation` 'render', required
    - `input` string: The Markdown to render.
    - `options` object
  - MarkdownToc: Extract a table of contents from Markdown headers.
    - `operation` 'toc', required
    - `input` string: The Markdown to scan.
    - `options` object
  - MarkdownStats: Compute document statistics for Markdown/plain text.
    - `operation` 'stats', required
    - `input` string: The text to analyze.
    - `options` object

## Response `200`

The operation ran.

- object
  - `ok` unknown, required
  - `tool` 'markdown', required
  - `operation` 'render' | 'toc' | 'stats', required
  - `result` unknown, required

## Other responses

- `400`: The request is not valid (https://programmes.net/api#invalid-request); The tool has no such operation (https://programmes.net/api#unknown-operation)
- `404`: No such tool (https://programmes.net/api#unknown-tool)
- `413`: The request or its input is too large (https://programmes.net/api#content-too-large)
- `415`: The body must be JSON (https://programmes.net/api#unsupported-media-type)
- `422`: An option is missing, of the wrong type or out of range (https://programmes.net/api#invalid-options); This call needs more CPU than one API call may use (https://programmes.net/api#refused); The operation could not process the input (https://programmes.net/api#tool-error)
- `429`: Too many requests (https://programmes.net/api#rate-limited)
- `500`: Internal error (https://programmes.net/api#internal-error)

---

[API](https://skmtc.dev/programmes/apis/programmes-net-api.md) · [All operations](https://skmtc.dev/programmes/apis/programmes-net-api/llms.txt) · [OpenAPI document](https://skmtc.dev/programmes/apis/programmes-net-api/revisions/aa939784a2e6?raw)