JSON to Markdown table API

Code examples

These examples send the sample as multipart/form-data and save the returned bytes unchanged. Set TABLECONVERT_API_KEY in your environment.

curl --fail-with-body --max-time 40 \
  'https://api.tableconvert.com/v2/convert/json-to-markdown' \
  --header "Authorization: Bearer $TABLECONVERT_API_KEY" \
  --form-string 'data=[
  {
    "task": "Write docs",
    "owner": "Alice",
    "status": "Done"
  },
  {
    "task": "Review API",
    "owner": "Bob",
    "status": "Pending"
  }
]' \
  --form-string 'output[escape]=false' \
  --form-string 'output[pretty]=true' \
  --form-string 'output[boldFirstRow]=false' \
  --form-string 'output[boldFirstColumn]=false' \
  --form-string 'output[firstHeader]=true' \
  --form-string 'output[align]=l' \
  --form-string 'output[simple]=false' \
  --form-string 'output[multilineHandling]=preserve' \
  --form-string 'output[includeLineNumbers]=false' \
  --output 'json-to-markdown.md'

import os
from pathlib import Path
import requests

endpoint = "https://api.tableconvert.com/v2/convert/json-to-markdown"
headers = {"Authorization": "Bearer " + os.environ["TABLECONVERT_API_KEY"]}
fields = {
    "data": (None, "[\n  {\n    \"task\": \"Write docs\",\n    \"owner\": \"Alice\",\n    \"status\": \"Done\"\n  },\n  {\n    \"task\": \"Review API\",\n    \"owner\": \"Bob\",\n    \"status\": \"Pending\"\n  }\n]"),
    "output[escape]": (None, "false"),
    "output[pretty]": (None, "true"),
    "output[boldFirstRow]": (None, "false"),
    "output[boldFirstColumn]": (None, "false"),
    "output[firstHeader]": (None, "true"),
    "output[align]": (None, "l"),
    "output[simple]": (None, "false"),
    "output[multilineHandling]": (None, "preserve"),
    "output[includeLineNumbers]": (None, "false"),
}

response = requests.post(endpoint, headers=headers, files=fields, timeout=40)
response.raise_for_status()
Path("json-to-markdown.md").write_bytes(response.content)

import { writeFile } from "node:fs/promises";

const form = new FormData();
form.set("data", "[\n  {\n    \"task\": \"Write docs\",\n    \"owner\": \"Alice\",\n    \"status\": \"Done\"\n  },\n  {\n    \"task\": \"Review API\",\n    \"owner\": \"Bob\",\n    \"status\": \"Pending\"\n  }\n]");
form.set("output[escape]", "false");
form.set("output[pretty]", "true");
form.set("output[boldFirstRow]", "false");
form.set("output[boldFirstColumn]", "false");
form.set("output[firstHeader]", "true");
form.set("output[align]", "l");
form.set("output[simple]", "false");
form.set("output[multilineHandling]", "preserve");
form.set("output[includeLineNumbers]", "false");

const response = await fetch("https://api.tableconvert.com/v2/convert/json-to-markdown", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.TABLECONVERT_API_KEY },
  body: form,
  signal: AbortSignal.timeout(40_000),
});
if (!response.ok) {
  throw new Error("HTTP " + response.status + ": " + await response.text());
}
await writeFile("json-to-markdown.md", Buffer.from(await response.arrayBuffer()));

Request parameters

A nonempty array of flat objects is the clearest record input. Object keys form a union of columns; nested structures are not automatically flattened.

Send one source: data, file, or url. The examples below use the source mode appropriate for this format.

Output options

Generate a pipe-delimited Markdown table for documentation. Alignment and formatting options apply to table text rather than rendering a full document.

Conversion rules

How the input is read

• For object arrays, columns follow keys in first-seen order; missing keys yield empty cells.
• null becomes the literal text null, while numbers and booleans become text during table normalization.
• A nested object becomes [object Object]; an array inside a field becomes comma-joined text rather than additional rows.
• Prepare explicit flat fields before conversion; the endpoint has no generic flatten parameter.

How the output is written

• The first row is treated as the table header unless an alternate header arrangement is chosen.
• Escape literal pipes and choose multilineHandling to match your Markdown renderer.
• GFM pipe tables are an extension and are not supported by every Markdown implementation.

When to use this API

Responses and errors

Check the response before retrying. A new HTTP request is a new conversion and may use credits again.

Limits, billing and versions

Local previews accept up to 200 KB. The current API implementation allows one uploaded file up to 50 MiB, limits each multipart text field to 1 MiB, and gives v2 conversion tasks a 30-second deadline. Deployment limits may be stricter. Read the returned error before retrying; some parser or renderer failures return HTTP 500.

Live calls follow the API credit policy. Failed conversions are refunded; a completed conversion is not undone if the download connection later fails.

References and format specifications

Format references explain the underlying syntax. The conversion rules and samples above describe TableConvert’s implementation.

• www.ecma-international.org
• github.github.com