JSON → Markdown API

Render JSON as a table or nested list.

POST /api/v1/convert/json-to-markdown renders a JSON document as either a GFM pipe table (flat array of objects) or a nested markdown bullet list. Useful for piping API responses into READMEs.

Overview

Array of flat objects → pipe table. Anything else → nested bullet list with bold keys. Two predictable shapes; no surprises.

Request

Authenticate with Authorization: Bearer YOUR_API_KEY and send a JSON body containing the parameters below. Pick your language:

curl -X POST 'https://trymarkdownviewer.com/api/v1/convert/json-to-markdown' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"json":"[{\"name\":\"Ada\",\"age\":36}]"}'

Body parameters

Field	Type	Required	Description
json	string	required	JSON source.
mode	"table" \| "list"	optional	Force a specific rendering. Defaults to 'table' (falls back to list).

Response

Success responses are wrapped in a data field. Errors use { error: { code, message } } with an appropriate HTTP status — see the error reference.

{
  "data": {
    "markdown": "| name | age |\n| --- | --- |\n| Ada | 36 |\n",
    "mode": "table"
  }
}

Use cases

API → docs

Render snapshot fixtures of an API response inside your docs.

Config previews

Show package.json or tsconfig snippets as a clean list view.

POST
/api/v1/convert/csv-to-table
CSV → Markdown table
Convert CSV (or TSV) to a GFM pipe table.

Try in browser

Free tools that run the same logic locally — no API key, no upload.

JSON to Markdown
Tables or nested lists

Try it

Send a real request against your account in the API playground. Errors there link straight back to the error reference.