Markdown table to PNG 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/markdown-to-png' \
  --header "Authorization: Bearer $TABLECONVERT_API_KEY" \
  --form-string 'data=| service   | status  | uptime |
|-----------|---------|--------|
| API       | Healthy | 99.95  |
| Dashboard | Healthy | 99.90  |
' \
  --output 'markdown-to-png.png'

import os
from pathlib import Path
import requests

endpoint = "https://api.tableconvert.com/v2/convert/markdown-to-png"
headers = {"Authorization": "Bearer " + os.environ["TABLECONVERT_API_KEY"]}
fields = {
    "data": (None, "| service   | status  | uptime |\n|-----------|---------|--------|\n| API       | Healthy | 99.95  |\n| Dashboard | Healthy | 99.90  |\n"),
}

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

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

const form = new FormData();
form.set("data", "| service   | status  | uptime |\n|-----------|---------|--------|\n| API       | Healthy | 99.95  |\n| Dashboard | Healthy | 99.90  |\n");

const response = await fetch("https://api.tableconvert.com/v2/convert/markdown-to-png", {
  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("markdown-to-png.png", Buffer.from(await response.arrayBuffer()));

Request parameters

Pipe-delimited Markdown table rows become a rectangular dataset. The alignment separator row is removed rather than treated as data.

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

Output options

Render extracted table values into a PNG image. The image shows a newly laid-out table and is not a screenshot of the source page.

This output format does not expose additional options.

Conversion rules

How the input is read

• Supply the table itself; prose, fenced examples and unrelated document lines should be removed first.
• The parser removes a recognized second-row alignment separator and trims cell edges.
• Escaped pipes are distinguished from cell separators, but inline Markdown is not rendered to rich text.
• Use one physical row per record; prepare multiline cell content deliberately.

How the output is written

• Save the binary image response directly as a .png file.
• A raster image is useful for fixed display but does not retain editable cell structure.
• Review text width, row count and glyph rendering before using the image in a report.
• The public image endpoint has no theme option: unregistered theme fields are discarded, and the API uses its fixed table styling.

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.

• github.github.com
• www.w3.org