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).
60 lines
1.9 KiB
Markdown
60 lines
1.9 KiB
Markdown
---
|
|
description: Extract frames from a video as a ZIP of images.
|
|
---
|
|
|
|
# Video to Frames
|
|
|
|
Extract individual frames from a video and download them as a ZIP archive of PNG or JPG images.
|
|
|
|
## API Endpoint
|
|
|
|
`POST /api/v1/tools/video-to-frames`
|
|
|
|
Accepts multipart form data with a video file and a JSON `settings` field.
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Required | Default | Description |
|
|
|-----------|------|----------|---------|-------------|
|
|
| mode | string | No | `"all"` | Extraction mode: `all`, `nth`, `timestamps` |
|
|
| n | integer | No | `10` | Extract every Nth frame (2-1000). Only used when mode is `"nth"` |
|
|
| timestamps | string | No | `""` | Comma-separated timestamps in seconds. Required when mode is `"timestamps"` |
|
|
| format | string | No | `"png"` | Image format for extracted frames: `png`, `jpg` |
|
|
|
|
## Example Request
|
|
|
|
Extract every 30th frame as JPG:
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/video-to-frames \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@clip.mp4" \
|
|
-F 'settings={"mode": "nth", "n": 30, "format": "jpg"}'
|
|
```
|
|
|
|
Extract frames at specific timestamps:
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/video-to-frames \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@clip.mp4" \
|
|
-F 'settings={"mode": "timestamps", "timestamps": "1.5,5,12.3"}'
|
|
```
|
|
|
|
## Example Response
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/clip-frames.zip",
|
|
"originalSize": 12500000,
|
|
"processedSize": 45000000
|
|
}
|
|
```
|
|
|
|
## Notes
|
|
|
|
- The `all` mode extracts every frame and can produce very large ZIP files for long videos. Use `nth` or `timestamps` mode for selective extraction.
|
|
- PNG preserves full quality but produces larger files. JPG is smaller but lossy.
|
|
- The response downloads as a ZIP archive containing sequentially numbered image files.
|