Things to check before integrating
Before you integrate
Move required attributes into explicit fields and flatten repeated nested groups before sending XML.
Before you integrate
The complete output is not one JSON array; consumers must parse records line by line.
Code examples
These examples send the sample as multipart/form-data and save the returned bytes unchanged. Set TABLECONVERT_API_KEY in your environment.
XML to JSON Lines API · cURL
curl --fail-with-body --max-time 40 \
'https://api.tableconvert.com/v2/convert/xml-to-jsonlines' \
--header "Authorization: Bearer $TABLECONVERT_API_KEY" \
--form-string 'data=<?xml version="1.0" encoding="UTF-8" ?>
<dataset>
<record><event>signup</event><user>alice</user><timestamp>2026-10-30</timestamp></record>
<record><event>purchase</event><user>bob</user><timestamp>2026-10-31</timestamp></record>
</dataset>' \
--form-string 'output[parsingJSON]=false' \
--form-string 'output[format]=object' \
--output 'xml-to-jsonlines.jsonl'Requires cURL. Download the sample input first when this example uploads a file.
XML to JSON Lines API · Python
import os
from pathlib import Path
import requests
endpoint = "https://api.tableconvert.com/v2/convert/xml-to-jsonlines"
headers = {"Authorization": "Bearer " + os.environ["TABLECONVERT_API_KEY"]}
fields = {
"data": (None, "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<dataset>\n <record><event>signup</event><user>alice</user><timestamp>2026-10-30</timestamp></record>\n <record><event>purchase</event><user>bob</user><timestamp>2026-10-31</timestamp></record>\n</dataset>"),
"output[parsingJSON]": (None, "false"),
"output[format]": (None, "object"),
}
response = requests.post(endpoint, headers=headers, files=fields, timeout=40)
response.raise_for_status()
Path("xml-to-jsonlines.jsonl").write_bytes(response.content)Requires Python 3 and requests. Install it with pip install requests.
XML to JSON Lines API · Node.js
import { writeFile } from "node:fs/promises";
const form = new FormData();
form.set("data", "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<dataset>\n <record><event>signup</event><user>alice</user><timestamp>2026-10-30</timestamp></record>\n <record><event>purchase</event><user>bob</user><timestamp>2026-10-31</timestamp></record>\n</dataset>");
form.set("output[parsingJSON]", "false");
form.set("output[format]", "object");
const response = await fetch("https://api.tableconvert.com/v2/convert/xml-to-jsonlines", {
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("xml-to-jsonlines.jsonl", Buffer.from(await response.arrayBuffer()));Requires Node.js 20 or later with built-in fetch, FormData and Blob.
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
The importer treats each direct child of the document root as a record and its child elements as fields. It is a record extractor, not a general XML schema or XSLT transformation.
| Parameter | Type | Default | Description |
|---|---|---|---|
data | string | — | Inline XML table content. Choose one of data, file or url. |
file | binary | — | Upload a xml file using multipart/form-data. |
url | string | — | 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 newline-delimited JSON with one record or array per line. The output is JSONL text, not a single enclosing JSON array.
| Parameter | Type | Default | Description |
|---|---|---|---|
output[parsingJSON] | boolean | false | Try JSON parsing for each cell; disable it to retain text such as identifiers with significant zeros. |
output[format] | string | object | Choose one object per data row or one array per grid row; array mode can include the header. |
Conversion rules
| Case | Behavior |
|---|---|
| Mapping rule 1 | Root-level child records supply rows, and their child element names supply the union of columns. |
| Mapping rule 2 | Object mode maps header names to one JSON object on each output line. |
| Mapping rule 3 | The source tree is flattened to direct record fields; XML attributes and repeated same-name elements need explicit preprocessing to avoid loss. |
How the input is read
- Use a root element containing repeated record elements with child-element fields.
- Cell values use element textContent; attributes and deep tree structure are not emitted as separate columns.
- Repeated field names within one record overwrite earlier values; normalize repeating groups first.
- Review namespace-prefixed names before generating code identifiers or a new schema.
How the output is written
- Object mode uses the first row as property names and emits one object for each remaining row.
- Array mode includes table rows as JSON arrays; confirm whether the header belongs in your consumer.
- Use a line-oriented parser and review per-cell parsingJSON when preserving IDs and blanks.
When to use this API
This conversion in practice
Use a record-oriented XML export as the starting dataset for a line-oriented ingestion fixture. Move required attributes into explicit fields and flatten repeated nested groups before sending XML.
JSON Lines
Prepare line-oriented records for a log, ingestion job or dataset fixture.
Responses and errors
| HTTP status | Description |
|---|---|
200 | text/plain; charset=utf-8 |
400 | Invalid input or conversion parameters. |
402 | Insufficient credits for this request. |
403 | Missing or invalid API key. |
413 | The input exceeds the configured request limit. |
415 | Unsupported input media type. |
429 | Rate limit exceeded. |
500 | The conversion could not be completed. |
503 | The 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 creditsUsing 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 overviewReferences and format specifications
Format references explain the underlying syntax. The conversion rules and samples above describe TableConvert’s implementation.