mirror of https://github.com/snapotter-hq/SnapOtter.git synced 2026-08-03 07:46:42 +02:00

Files

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.9 KiB

Raw Blame History

description

description
View, edit, or strip audio metadata tags (ID3).

Audio Metadata

View, edit, or strip audio metadata tags such as title, artist, and album (ID3 and similar tag formats).

API Endpoint

POST /api/v1/tools/audio-metadata

Accepts multipart form data with an audio file and a JSON settings field.

Parameters

Parameter	Type	Required	Default	Description
strip	boolean	No	`false`	Remove all existing metadata tags
title	string	No	-	Set the title tag (max 500 characters)
artist	string	No	-	Set the artist tag (max 500 characters)
album	string	No	-	Set the album tag (max 500 characters)

Example Request

Edit metadata tags:

curl -X POST http://localhost:1349/api/v1/tools/audio-metadata \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@audio.mp3" \
  -F 'settings={"title": "My Song", "artist": "Artist Name", "album": "Album Name"}'

Strip all metadata:

curl -X POST http://localhost:1349/api/v1/tools/audio-metadata \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@audio.mp3" \
  -F 'settings={"strip": true}'

Example Response

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/audio.mp3",
  "originalSize": 4500000,
  "processedSize": 4480000,
  "metadata": {
    "container": "mp3",
    "durationS": 245.3,
    "bitrateKbps": 192,
    "tags": {
      "title": "My Song",
      "artist": "Artist Name",
      "album": "Album Name"
    }
  }
}

Notes

The response includes a metadata object with container format, duration, bitrate, and current tags.
When strip is true, all tag fields are ignored and every existing tag is removed.
Only the tags you provide are updated; unspecified tags remain unchanged.
Output format matches the input format.

1.9 KiB Raw Blame History