mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtter
8532f3227b
Reconcile every tool page's parameters, defaults, and response shape against the tool's Zod settings schema and executionHint in code. Notable fixes: color-palette (add count + format params, hex output, median-cut algorithm), favicon (add 5 params, was documented as having none), qr-generate (add logoDataUri), convert (add ppm/eps/tga formats), video-loudnorm (-16 LUFS not -14), smart-crop (async 202 not sync 200), images-to-video (1080x1080 square), and several output-filename and behavior-note corrections. Also normalize API endpoint paths to /api/v1/tools/<id> (no modality segment) and standardize curl examples on the Docker API port 1349. Verified with a clean docs build.
58 lines
1.6 KiB
Markdown
58 lines
1.6 KiB
Markdown
---
|
|
description: Convert between CSV and JSON, both directions.
|
|
---
|
|
|
|
# CSV to JSON
|
|
|
|
Convert between CSV and JSON formats in both directions. Upload a CSV or TSV file to get a JSON array of objects, or upload a JSON array to get a CSV file.
|
|
|
|
## API Endpoint
|
|
|
|
`POST /api/v1/tools/csv-json`
|
|
|
|
Accepts multipart form data with a CSV, TSV, or JSON file and a JSON `settings` field.
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Required | Default | Description |
|
|
|-----------|------|----------|---------|-------------|
|
|
| pretty | boolean | No | `true` | Pretty-print JSON output with indentation |
|
|
|
|
## Example Request
|
|
|
|
CSV to JSON:
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/csv-json \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@users.csv" \
|
|
-F 'settings={"pretty": true}'
|
|
```
|
|
|
|
JSON to CSV:
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/csv-json \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@users.json" \
|
|
-F 'settings={}'
|
|
```
|
|
|
|
## Example Response
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/users.json",
|
|
"originalSize": 1500,
|
|
"processedSize": 2200
|
|
}
|
|
```
|
|
|
|
## Notes
|
|
|
|
- Conversion direction is auto-detected from the input file extension: `.csv` or `.tsv` produces `.json`, and `.json` produces `.csv`.
|
|
- The `pretty` parameter only affects JSON output. When set to `false`, the output is a compact single-line JSON string.
|
|
- JSON input must be an array of objects with consistent keys. Each object becomes a row, and each key becomes a column header.
|
|
- TSV (tab-separated values) files are supported alongside CSV.
|