mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtter
bd84728588
- Rewrite OpenAPI spec to match actual code (988 lines changed):
- Fix ToolResponse schema (add previewUrl, savedFileId)
- Fix Error schema shape ({error, details} not {statusCode, error, message})
- Fix POST /api/auth/register URL (was /api/auth/users)
- Fix login/session responses (7 missing user fields + expiresAt)
- Fix 8 endpoints returning 204 → 200 with {ok: true}
- Fix pipeline execute field name (steps → pipeline)
- Fix API keys response key (keys → apiKeys)
- Fix settings response wrapper, teams UUID type
- Rewrite 7 major tool response schemas (info, barcode-read,
find-duplicates, compare, remove-background, upscale, ocr, blur-faces)
- Fix files/save-result (JSON → multipart), files/upload (201 + array)
- Fix SSE progress schema (integers not arrays)
- Add 422/501 error responses to AI and processing tools
- Fix settings required → optional on 29 tool endpoints
- Add 5 missing color adjustment fields to alias endpoints
- Rewrite rest.md tool parameter descriptions (12 tools fixed)
- Add Tool Sub-Routes section to rest.md (11 endpoints)
- Fix file library, settings, pipeline, auth docs in rest.md
- Fix API key hashing description (SHA-256 → scrypt)
- Fix "GitHub Pages" → "Cloudflare Pages" in architecture + deployment docs
- Fix tool count "45+" → "47" across all doc surfaces
- Fix branding endpoint paths in rest.md (/branding/logo → /settings/logo)
39 lines
1.8 KiB
Markdown
39 lines
1.8 KiB
Markdown
---
|
|
layout: home
|
|
|
|
hero:
|
|
name: "SnapOtter"
|
|
text: "A Self Hosted Image Manipulator"
|
|
tagline: 47 tools. Local AI. No cloud. Your images stay on your machine.
|
|
actions:
|
|
- theme: brand
|
|
text: Get started
|
|
link: /guide/getting-started
|
|
- theme: alt
|
|
text: API reference
|
|
link: /api/rest
|
|
|
|
features:
|
|
- title: 47 Image Tools
|
|
details: Resize, crop, compress, convert, watermark, color adjust, vectorize, create GIFs, build collages, generate passport photos, find duplicates, and more.
|
|
- title: Local AI
|
|
details: 14 AI-powered tools - remove backgrounds, upscale, enhance images, restore and colorize old photos, erase objects, blur faces, enhance faces, extract text (OCR). All on your hardware, no internet required.
|
|
- title: Pipelines
|
|
details: Chain tools into reusable workflows with unlimited steps. Batch process unlimited images at once with a single request.
|
|
- title: REST API
|
|
details: Every tool available via API with API key auth. Interactive docs at /api/docs, plus /llms.txt and /llms-full.txt for AI agents.
|
|
- title: File Library
|
|
details: Persistent file storage with full version history. Every processing step is tracked so you can trace the full tool chain from original to final output.
|
|
- title: Teams & Access Control
|
|
details: Multi-user support with admin/user roles, team grouping, per-resource permissions, and audit logging for all sensitive actions.
|
|
---
|
|
|
|
<div class="quick-start-banner">
|
|
|
|
```bash
|
|
docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest \
|
|
&& printf "\n 🦦 SnapOtter\n ────────────────────────────────────────\n\n ➜ Open http://localhost:1349\n ➜ Login admin / admin\n ➜ Docs https://docs.snapotter.com\n\n"
|
|
```
|
|
|
|
</div>
|