Things to check before integrating
Before you integrate
Select and flatten the required record fields before sending nested JSON.
Before you integrate
Invalid header names, raw ampersands and CDATA terminators require review before XML validation.
Code examples
These examples send the sample as multipart/form-data and save the returned bytes unchanged. Set TABLECONVERT_API_KEY in your environment.
JSON to XML records API · cURL
curl --fail-with-body --max-time 40 \
'https://api.tableconvert.com/v2/convert/json-to-xml' \
--header "Authorization: Bearer $TABLECONVERT_API_KEY" \
--form-string 'data=[
{
"id": "101",
"title": "Notebook",
"available": true
},
{
"id": "102",
"title": "Marker",
"available": false
}
]' \
--form-string 'output[minify]=false' \
--form-string 'output[escape]=true' \
--form-string 'output[rootElement]=dataset' \
--form-string 'output[rowElement]=record' \
--form-string 'output[declaration]=true' \
--form-string 'output[attributes]=false' \
--form-string 'output[cdata]=false' \
--form-string 'output[encoding]=UTF-8' \
--form-string 'output[indentSize]=2' \
--output 'json-to-xml.xml'Requires cURL. Download the sample input first when this example uploads a file.
JSON to XML records API · Python
import os
from pathlib import Path
import requests
endpoint = "https://api.tableconvert.com/v2/convert/json-to-xml"
headers = {"Authorization": "Bearer " + os.environ["TABLECONVERT_API_KEY"]}
fields = {
"data": (None, "[\n {\n \"id\": \"101\",\n \"title\": \"Notebook\",\n \"available\": true\n },\n {\n \"id\": \"102\",\n \"title\": \"Marker\",\n \"available\": false\n }\n]"),
"output[minify]": (None, "false"),
"output[escape]": (None, "true"),
"output[rootElement]": (None, "dataset"),
"output[rowElement]": (None, "record"),
"output[declaration]": (None, "true"),
"output[attributes]": (None, "false"),
"output[cdata]": (None, "false"),
"output[encoding]": (None, "UTF-8"),
"output[indentSize]": (None, "2"),
}
response = requests.post(endpoint, headers=headers, files=fields, timeout=40)
response.raise_for_status()
Path("json-to-xml.xml").write_bytes(response.content)Requires Python 3 and requests. Install it with pip install requests.
JSON to XML records API · Node.js
import { writeFile } from "node:fs/promises";
const form = new FormData();
form.set("data", "[\n {\n \"id\": \"101\",\n \"title\": \"Notebook\",\n \"available\": true\n },\n {\n \"id\": \"102\",\n \"title\": \"Marker\",\n \"available\": false\n }\n]");
form.set("output[minify]", "false");
form.set("output[escape]", "true");
form.set("output[rootElement]", "dataset");
form.set("output[rowElement]", "record");
form.set("output[declaration]", "true");
form.set("output[attributes]", "false");
form.set("output[cdata]", "false");
form.set("output[encoding]", "UTF-8");
form.set("output[indentSize]", "2");
const response = await fetch("https://api.tableconvert.com/v2/convert/json-to-xml", {
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-xml.xml", 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
A nonempty array of flat objects is the clearest record input. Object keys form a union of columns; nested structures are not automatically flattened.
| Parameter | Type | Default | Description |
|---|---|---|---|
data | string | — | Inline JSON table content. Choose one of data, file or url. |
file | binary | — | Upload a json 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 a root element containing row elements with either child-field elements or attributes. This is a tabular XML representation rather than arbitrary source-tree reconstruction.
| Parameter | Type | Default | Description |
|---|---|---|---|
output[minify] | boolean | false | Reduce generated layout whitespace; inspect any format-specific effects on cell content. |
output[escape] | boolean | true | Escape characters meaningful to the destination markup when cells should remain plain text. |
output[rootElement] | string | dataset | Name the root XML element containing all generated records. |
output[rowElement] | string | record | Name each record element inside the XML root. |
output[declaration] | boolean | true | Include an XML declaration before the generated root element. |
output[attributes] | boolean | false | Represent XML row fields as attributes rather than child elements. |
output[cdata] | boolean | false | Place element text in CDATA sections; inspect values containing the CDATA terminator. |
output[encoding] | string | UTF-8 | Set the XML declaration’s encoding label; verify it matches how you save the response bytes. |
output[indentSize] | string | 2 | Set generated text indentation; it controls formatting rather than data types. |
Conversion rules
| Case | Behavior |
|---|---|
| Mapping rule 1 | The union of object keys forms the header, and each flat object supplies one row of text cells. |
| Mapping rule 2 | Header names become child-element or attribute names under each generated row element. |
| Mapping rule 3 | This is a flat-record remapping, not a lossless JSON-tree conversion; missing keys, literal null text and optional scalar parsing affect the result. |
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
- Header values become field names, while rootElement and rowElement name the surrounding nodes.
- Choose attributes or child elements deliberately, and keep XML escaping enabled for plain text.
- Validate element names and CDATA terminators; naming an encoding does not recreate original XML metadata.
When to use this API
This conversion in practice
Use an application JSON response as the starting dataset for an XML import payload. Select and flatten the required record fields before sending nested JSON.
XML records
Prepare a simple record-oriented payload for an XML import interface.
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.