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).
51 lines
1.7 KiB
Markdown
51 lines
1.7 KiB
Markdown
---
|
|
description: Convert speech to text with AI-powered transcription.
|
|
---
|
|
|
|
# Transcribe Audio
|
|
|
|
Convert speech to text using AI-powered transcription (faster-whisper). Supports plain text, SRT, and VTT output formats with automatic or manual language selection.
|
|
|
|
## API Endpoint
|
|
|
|
`POST /api/v1/tools/transcribe-audio`
|
|
|
|
Accepts multipart form data with an audio file and a JSON `settings` field.
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Required | Default | Description |
|
|
|-----------|------|----------|---------|-------------|
|
|
| language | string | No | `"auto"` | Language: `auto`, `en`, `de`, `fr`, `es`, `zh`, `ja`, `ko`, `id`, `th`, `vi` |
|
|
| outputFormat | string | No | `"txt"` | Output format: `txt`, `srt`, `vtt` |
|
|
|
|
## Example Request
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/transcribe-audio \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@audio.mp3" \
|
|
-F 'settings={"language": "en", "outputFormat": "srt"}'
|
|
```
|
|
|
|
## Example Response
|
|
|
|
This is an async tool. The API returns `202 Accepted` immediately:
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"async": true
|
|
}
|
|
```
|
|
|
|
Track progress via SSE at `GET /api/v1/jobs/{jobId}/progress`. When the job completes, the SSE stream delivers the final result with a `downloadUrl`.
|
|
|
|
## Notes
|
|
|
|
- Requires the **transcription** feature bundle to be installed. Returns `501 Not Implemented` if the bundle is not available.
|
|
- Uses faster-whisper for transcription. Language `auto` detects the spoken language automatically.
|
|
- `srt` and `vtt` formats include timestamps for each segment, suitable for subtitles.
|
|
- `txt` format returns plain text without timestamps.
|
|
- This is a long-running AI tool; processing time depends on audio length and server hardware.
|