Skip to content
API REFERENCEv2

Markdown table to TOML API

Prepare a TOML-style key-value draft from a README or documentation table with the TableConvert conversion API. Select a settings-only Markdown table and replace presentation headings with valid configuration keys before generating assignments.

REST APIv2 · Direct outputMarkdown table → TOML key-value draft1 credits per successful conversion

Try this conversion

Inspect a real sample, preview locally, or send a live request with your own key.

Verified sample
POSThttps://api.tableconvert.com/v2/convert/markdown-to-toml

TOML key-value draft response

name = "frontend"
mode = "production"
retries = "3"

name = "worker"
mode = "development"
retries = "1"

Local previews use no credits and process the first imported table or worksheet.

A successful live request uses 1 credits.

Your key is sent only to the conversion API and is never saved by this page.

Things to check before integrating

Before you integrate

Send only the pipe table and check escaped pipes and inline formatting in values.

Before you integrate

Multiple rows repeat top-level keys and are not valid TOML as a whole; restructure into tables or arrays of tables and validate escaping.

Code examples

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

Markdown table to TOML API · cURL

curl --fail-with-body --max-time 40 \
  'https://api.tableconvert.com/v2/convert/markdown-to-toml' \
  --header "Authorization: Bearer $TABLECONVERT_API_KEY" \
  --form-string 'data=| name     | mode        | retries |
|----------|-------------|---------|
| frontend | production  | 3       |
| worker   | development | 1       |
' \
  --output 'markdown-to-toml.toml'

Requires cURL. Download the sample input first when this example uploads a file.

Authentication

Send Authorization: Bearer YOUR_API_KEY. Let the HTTP client set the multipart boundary; do not set Content-Type manually.

Keep production API keys in server-side environment variables.

Request parameters

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

ParameterTypeDefaultDescription
datastring—Inline Markdown table content. Choose one of data, file or url.
filebinary—Upload a md file using multipart/form-data.
urlstring—A supported publicly accessible HTTP or HTTPS file URL.

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

Output options

Generate quoted TOML-style key-value assignments from columns. Multiple records currently repeat top-level keys, so multirow output must be restructured before TOML parsing.

This output format does not expose additional options.

Conversion rules

CaseBehavior
Mapping rule 1The Markdown header and body rows remain data; the alignment-only separator is discarded.
Mapping rule 2Header names become assignment keys and each row emits another set of quoted assignments.
Mapping rule 3Select a settings-only Markdown table and replace presentation headings with valid configuration keys before generating assignments.

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

  • Headers become keys and each row emits an assignment for each column.
  • TOML forbids duplicate keys in one table; wrap multiple records into reviewed array-of-table sections manually.
  • Validate key syntax, quote escaping and newlines; this endpoint is a configuration-text starting point.

When to use this API

This conversion in practice

Use a README or documentation table as the starting dataset for a configuration draft that will be reorganized into valid TOML. Send only the pipe table and check escaped pipes and inline formatting in values.

TOML key-value draft

Draft a single-record configuration or a multirow template to restructure into TOML tables.

Responses and errors

HTTP statusDescription
200text/plain; charset=utf-8
400Invalid input or conversion parameters.
402Insufficient credits for this request.
403Missing or invalid API key.
413The input exceeds the configured request limit.
415Unsupported input media type.
429Rate limit exceeded.
500The conversion could not be completed.
503The renderer is unavailable or the request timed out.

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.

View API pricing and credits

Using API v1?

This page documents v2, which returns the output directly. API v1 wraps the result in a JSON envelope. Check the overview before changing an existing integration.

API overview

References and format specifications

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