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.
48 lines
1.4 KiB
Markdown
48 lines
1.4 KiB
Markdown
---
|
|
description: Split a CSV into smaller files by row count.
|
|
---
|
|
|
|
# Split CSV
|
|
|
|
Split a large CSV or TSV file into smaller files by row count. Returns a ZIP archive containing the parts.
|
|
|
|
## API Endpoint
|
|
|
|
`POST /api/v1/tools/split-csv`
|
|
|
|
Accepts multipart form data with a CSV file and a JSON `settings` field.
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Required | Default | Description |
|
|
|-----------|------|----------|---------|-------------|
|
|
| rowsPerFile | integer | No | `1000` | Number of data rows per output file (1--1,000,000) |
|
|
| keepHeader | boolean | No | `true` | Repeat the header row in each output file |
|
|
|
|
## Example Request
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/split-csv \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@large-dataset.csv" \
|
|
-F 'settings={"rowsPerFile": 500, "keepHeader": true}'
|
|
```
|
|
|
|
## Example Response
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/large-dataset_parts.zip",
|
|
"originalSize": 1048576,
|
|
"processedSize": 1050000
|
|
}
|
|
```
|
|
|
|
## Notes
|
|
|
|
- Output is always a ZIP archive containing the split CSV parts, named sequentially (e.g. `part-1.csv`, `part-2.csv`).
|
|
- When `keepHeader` is `true`, each part includes the original header row so each file can be used independently.
|
|
- Both CSV and TSV files are accepted as input.
|
|
- The row count refers to data rows only; the header row is not counted.
|