Things to check before integrating
Before you integrate
Check the separator, quoted line breaks and identifier columns before generating the destination.
Before you integrate
Jira wiki text is different from Atlassian Document Format and may not render in every modern field.
Code examples
These examples send the sample as multipart/form-data and save the returned bytes unchanged. Set TABLECONVERT_API_KEY in your environment.
CSV to Jira wiki table API · cURL
curl --fail-with-body --max-time 40 \
'https://api.tableconvert.com/v2/convert/csv-to-jira' \
--header "Authorization: Bearer $TABLECONVERT_API_KEY" \
--form-string 'data="issue","status","assignee"
"APP101","In progress","Alice"
"APP102","Done","Bob"' \
--form-string 'output[escape]=true' \
--form-string 'output[rowHeader]=true' \
--form-string 'output[colHeader]=false' \
--output 'csv-to-jira.txt'Requires cURL. Download the sample input first when this example uploads a file.
CSV to Jira wiki table API · Python
import os
from pathlib import Path
import requests
endpoint = "https://api.tableconvert.com/v2/convert/csv-to-jira"
headers = {"Authorization": "Bearer " + os.environ["TABLECONVERT_API_KEY"]}
fields = {
"data": (None, "\"issue\",\"status\",\"assignee\"\r\n\"APP101\",\"In progress\",\"Alice\"\r\n\"APP102\",\"Done\",\"Bob\""),
"output[escape]": (None, "true"),
"output[rowHeader]": (None, "true"),
"output[colHeader]": (None, "false"),
}
response = requests.post(endpoint, headers=headers, files=fields, timeout=40)
response.raise_for_status()
Path("csv-to-jira.txt").write_bytes(response.content)Requires Python 3 and requests. Install it with pip install requests.
CSV to Jira wiki table API · Node.js
import { writeFile } from "node:fs/promises";
const form = new FormData();
form.set("data", "\"issue\",\"status\",\"assignee\"\r\n\"APP101\",\"In progress\",\"Alice\"\r\n\"APP102\",\"Done\",\"Bob\"");
form.set("output[escape]", "true");
form.set("output[rowHeader]", "true");
form.set("output[colHeader]", "false");
const response = await fetch("https://api.tableconvert.com/v2/convert/csv-to-jira", {
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("csv-to-jira.txt", 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
Delimited text is parsed into a rectangular table before the requested output is generated. A header row and consistent separators make field mapping explicit.
| Parameter | Type | Default | Description |
|---|---|---|---|
data | string | — | Inline CSV table content. Choose one of data, file or url. |
file | binary | — | Upload a csv 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 legacy Jira wiki table notation with optional row and column headers. This is not a Jira issue-creation or rich-text editor API.
| Parameter | Type | Default | Description |
|---|---|---|---|
output[escape] | boolean | true | Escape characters meaningful to the destination markup when cells should remain plain text. |
output[rowHeader] | boolean | true | Mark the first row as a header using the destination table notation. |
output[colHeader] | boolean | false | Mark the first column as header cells using the destination table notation. |
Conversion rules
| Case | Behavior |
|---|---|
| Mapping rule 1 | The CSV header becomes the table’s first row; subsequent delimited records become data rows. |
| Mapping rule 2 | Rows are emitted using single or double pipe separators for data and headers. |
| Mapping rule 3 | CSV separators disappear at extraction; escape the destination table’s own delimiters in cell values. |
How the input is read
- Use the first row for column names when the destination creates named records or schema fields.
- Quoted separators, escaped quotes and quoted line breaks are parsed as cell content; inconsistent rows are padded to the table width.
- Normalize mixed separators before conversion; automatic delimiter detection is a heuristic.
- CSV cells become text; a numeric-looking identifier and an actual numeric type are not interchangeable.
How the output is written
- Header cells use Jira wiki pipe notation.
- Escape literal pipes when appropriate for the destination renderer.
- Check whether your Jira field supports wiki notation; modern editor documents may need a different representation.
When to use this API
This conversion in practice
Use a delimited export as the starting dataset for a legacy Jira wiki field. Check the separator, quoted line breaks and identifier columns before generating the destination.
Jira wiki table
Prepare a table for a legacy wiki-rendered issue description.
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.