SnapOtter/apps/docs/index.md at 4bfbc51b77c365ecc48749cbf3dcdf47ce7f9d8b

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

Files

T

AshimandGitHub 97938bdc47 feat: API sync and documentation audit - 100% endpoint coverage (#94 )

Code quality:
- Add Zod validation to 14 route handlers that used raw JSON.parse
  (favicon, find-duplicates, barcode-read, upscale, blur-faces,
  erase-object, colorize, enhance-faces, red-eye-removal,
  remove-background/effects, auth, api-keys, roles, teams,
  analytics, settings, user-files)
- Standardize error responses to safeParse + formatZodErrors pattern
- Replace unsafe `as` type casts with schema validation

OpenAPI spec (89 -> 115 operations):
- Add 14 missing tool endpoints (adjust-colors, sharpening,
  optimize-for-web, image-enhancement, noise-removal, red-eye-removal,
  restore-photo, passport-photo, colorize, enhance-faces, image-to-base64)
- Add 12 missing non-tool endpoints (analytics, features, audit-log,
  roles, admin-health)
- Add typed error schemas for 401/403/409 responses
- Add descriptions to all path parameters
- Bump version from 0.9.0 to 1.15.9

Documentation:
- Fix 8 incorrect env var defaults in configuration guide
- Add 15 undocumented env vars to configuration guide
- Fix tool ID mismatch (color-adjustments -> adjust-colors)
- Add 4 new API sections (Roles, Audit Log, Analytics, Features)
- Add image-enhancement to AI engine reference
- Update AI tool count from 13 to 14 across all docs
- Add 6 missing doc links to README

2026-04-23 20:26:58 +08:00

1.5 KiB

Raw Blame History

layout, hero, features

layout

hero

features

home

name

text

tagline

actions

ashim

A Self Hosted Image Manipulator

45+ tools. Local AI. No cloud. Your images stay on your machine.

theme	text	link
brand	Get started	/guide/getting-started

theme	text	link
alt	API reference	/api/rest

title	details
45+ Image Tools	Resize, crop, compress, convert, watermark, color adjust, vectorize, create GIFs, build collages, generate passport photos, find duplicates, and more.

title	details
Local AI	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	details
Pipelines	Chain tools into reusable workflows with up to 20 steps. Batch process up to 200 images at once with a single request.

title	details
REST API	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	details
File Library	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	details
Teams & Access Control	Multi-user support with admin/user roles, team grouping, per-resource permissions, and audit logging for all sensitive actions.

docker run -d --name ashim -p 1349:1349 -v ashim-data:/data ghcr.io/ashim-hq/ashim:latest

1.5 KiB Raw Blame History

1.5 KiB

Raw Blame History