mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtterandGitHub
ecc0a45f0e
* fix(docs): keep gray-matter on js-yaml 3 so the docs site builds The js-yaml >=4.2.0 override from #257 forced js-yaml 4 onto gray-matter (used by vitepress and vitepress-plugin-llms), which calls the removed yaml.safeLoad and broke `vitepress build`. Scope a gray-matter>js-yaml ^3.14.1 override so gray-matter keeps the v3 API (build-time, trusted frontmatter only) while app code stays on js-yaml 4.2.0+. * docs: add per-tool reference pages for all 157 tools, with a modality sidebar Generate /tools/<id> pages for the 104 tools that lacked one (video 29, audio 17, document 36, data 10, and 12 newer image tools), matching the existing page format (API endpoint, parameters from the OpenAPI spec, curl example, response, notes). Async/AI tools document the 202+SSE flow and feature-bundle requirement. Sidebar: add Video / Audio / PDF & Documents / Data groups with per-tool links, fold the 12 new image tools into the existing image categories, and replace the placeholder rest.md-anchor group. Docs site builds cleanly (157 pages, no dead links).
71 lines
1.9 KiB
Markdown
71 lines
1.9 KiB
Markdown
---
|
|
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:
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
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
|
|
|
|
```json
|
|
{
|
|
"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.
|