Files
SnapOtter/apps/docs/tools/data/yaml-json.md
T
SnapOtter 8532f3227b docs: audit all 157 tool pages against live schemas
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.
2026-06-18 14:12:28 +08:00

1.3 KiB

description
description
Convert between YAML and JSON, both directions.

YAML / JSON

Convert between YAML and JSON formats in both directions. Upload a YAML file to get JSON, or upload a JSON file to get YAML.

API Endpoint

POST /api/v1/tools/yaml-json

Accepts multipart form data with a YAML or JSON file. No settings field is required.

Parameters

This tool has no configurable parameters. The conversion direction is determined by the input file extension.

Example Request

YAML to JSON:

curl -X POST http://localhost:1349/api/v1/tools/yaml-json \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@config.yaml"

JSON to YAML:

curl -X POST http://localhost:1349/api/v1/tools/yaml-json \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@config.json"

Example Response

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/config.json",
  "originalSize": 620,
  "processedSize": 780
}

Notes

  • Conversion direction is auto-detected from the input file extension: .yaml or .yml produces .json, and .json produces .yaml.
  • Both .yaml and .yml extensions are accepted.
  • Only the first document in a multi-document YAML file is converted; additional documents separated by --- are ignored.