mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
docs: add color-blindness tool to API docs and update tool counts
This commit is contained in:
@@ -15,7 +15,7 @@
|
|||||||
|
|
||||||
## Key Features
|
## Key Features
|
||||||
|
|
||||||
- **48 image tools** - Resize, crop, compress, convert, watermark, color adjust, vectorize, create GIFs, find duplicates, generate passport photos, and more
|
- **49 image tools** - Resize, crop, compress, convert, watermark, color adjust, vectorize, create GIFs, find duplicates, generate passport photos, and more
|
||||||
- **Local AI** - Remove backgrounds, upscale images, restore and colorize old photos, erase objects, blur faces, enhance faces, extract text (OCR). All on your hardware - no internet required
|
- **Local AI** - Remove backgrounds, upscale images, restore and colorize old photos, erase objects, blur faces, enhance faces, extract text (OCR). All on your hardware - no internet required
|
||||||
- **Pipelines** - Chain tools into reusable workflows with unlimited steps. Batch process unlimited images at once
|
- **Pipelines** - Chain tools into reusable workflows with unlimited steps. Batch process unlimited images at once
|
||||||
- **REST API** - Every tool available via API with API key auth. Interactive docs at `/api/docs`
|
- **REST API** - Every tool available via API with API key auth. Interactive docs at `/api/docs`
|
||||||
|
|||||||
@@ -2053,6 +2053,50 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/UnauthorizedError"
|
$ref: "#/components/schemas/UnauthorizedError"
|
||||||
|
|
||||||
|
/api/v1/tools/color-blindness:
|
||||||
|
post:
|
||||||
|
tags: [Tools]
|
||||||
|
summary: Color blindness simulation
|
||||||
|
description: Simulate how an image appears to people with various types of color vision deficiency.
|
||||||
|
security:
|
||||||
|
- bearerAuth: []
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
multipart/form-data:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
required: [file]
|
||||||
|
properties:
|
||||||
|
file:
|
||||||
|
type: string
|
||||||
|
format: binary
|
||||||
|
description: Image file to process
|
||||||
|
settings:
|
||||||
|
type: string
|
||||||
|
description: |
|
||||||
|
JSON string with options:
|
||||||
|
- `simulationType` (enum, default "deuteranomaly") -- Type of color vision deficiency to simulate. One of: protanopia, deuteranopia, tritanopia, protanomaly, deuteranomaly, tritanomaly, achromatopsia, blueConeMonochromacy
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Processed image
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/ToolResponse"
|
||||||
|
"400":
|
||||||
|
description: Invalid input
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/Error"
|
||||||
|
"401":
|
||||||
|
description: Authentication required
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/UnauthorizedError"
|
||||||
|
|
||||||
/api/v1/tools/gif-tools:
|
/api/v1/tools/gif-tools:
|
||||||
post:
|
post:
|
||||||
tags: [Tools]
|
tags: [Tools]
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ import llmstxt from "vitepress-plugin-llms";
|
|||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
title: "SnapOtter",
|
title: "SnapOtter",
|
||||||
description:
|
description:
|
||||||
"Documentation for SnapOtter - A Self Hosted Image Manipulator. 48 tools, local AI, pipelines, REST API.",
|
"Documentation for SnapOtter - A Self Hosted Image Manipulator. 49 tools, local AI, pipelines, REST API.",
|
||||||
base: "/",
|
base: "/",
|
||||||
appearance: { initialValue: "light" },
|
appearance: { initialValue: "light" },
|
||||||
srcDir: ".",
|
srcDir: ".",
|
||||||
@@ -48,7 +48,7 @@ export default defineConfig({
|
|||||||
`,
|
`,
|
||||||
customTemplateVariables: {
|
customTemplateVariables: {
|
||||||
description:
|
description:
|
||||||
"SnapOtter is a self-hosted, open-source image processing platform with 48 tools including AI/ML. Runs in a single Docker container with GPU auto-detection.",
|
"SnapOtter is a self-hosted, open-source image processing platform with 49 tools including AI/ML. Runs in a single Docker container with GPU auto-detection.",
|
||||||
details:
|
details:
|
||||||
"Resize, compress, convert, remove backgrounds, upscale, run OCR, and more - without sending images to external services.",
|
"Resize, compress, convert, remove backgrounds, upscale, run OCR, and more - without sending images to external services.",
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -131,6 +131,7 @@ curl -X POST http://localhost:1349/api/v1/tools/<toolId>/batch \
|
|||||||
| `adjust-colors` | Adjust Colors | `brightness`, `contrast`, `exposure`, `saturation`, `temperature`, `tint`, `hue`, `sharpness`, `red`, `green`, `blue`, `effect` (none/grayscale/sepia/invert) |
|
| `adjust-colors` | Adjust Colors | `brightness`, `contrast`, `exposure`, `saturation`, `temperature`, `tint`, `hue`, `sharpness`, `red`, `green`, `blue`, `effect` (none/grayscale/sepia/invert) |
|
||||||
| `sharpening` | Sharpening | `method` (adaptive/unsharp-mask/high-pass), `sigma`, `m1`, `m2`, `x1`, `y2`, `y3`, `amount`, `radius`, `threshold`, `strength`, `kernelSize` (3/5), `denoise` (off/light/medium/strong) |
|
| `sharpening` | Sharpening | `method` (adaptive/unsharp-mask/high-pass), `sigma`, `m1`, `m2`, `x1`, `y2`, `y3`, `amount`, `radius`, `threshold`, `strength`, `kernelSize` (3/5), `denoise` (off/light/medium/strong) |
|
||||||
| `replace-color` | Replace Color | `sourceColor`, `targetColor` (replacement), `makeTransparent`, `tolerance` |
|
| `replace-color` | Replace Color | `sourceColor`, `targetColor` (replacement), `makeTransparent`, `tolerance` |
|
||||||
|
| `color-blindness` | Color Blindness Simulation | `simulationType` (protanopia/deuteranopia/tritanopia/protanomaly/deuteranomaly/tritanomaly/achromatopsia/blueConeMonochromacy, default "deuteranomaly") |
|
||||||
|
|
||||||
### AI Tools
|
### AI Tools
|
||||||
|
|
||||||
|
|||||||
@@ -43,7 +43,7 @@ Shared TypeScript types, constants (like `APP_VERSION` and tool definitions), an
|
|||||||
|
|
||||||
### API (`apps/api`)
|
### API (`apps/api`)
|
||||||
|
|
||||||
A Fastify v5 server exposing 48 tool routes (33 standard image operations + 15 AI-powered) that handles:
|
A Fastify v5 server exposing 49 tool routes (33 standard image operations + 15 AI-powered) that handles:
|
||||||
- File uploads, temporary workspace management, and persistent file storage
|
- File uploads, temporary workspace management, and persistent file storage
|
||||||
- User file library with version chains (`user_files` table) -- each processed result links back to its source file and records which tool was applied, with auto-generated thumbnails for the Files page
|
- User file library with version chains (`user_files` table) -- each processed result links back to its source file and records which tool was applied, with auto-generated thumbnails for the Files page
|
||||||
- Tool execution (routes each tool request to the image engine or AI bridge)
|
- Tool execution (routes each tool request to the image engine or AI bridge)
|
||||||
|
|||||||
@@ -64,7 +64,7 @@ pnpm dev
|
|||||||
|
|
||||||
## What You Can Do
|
## What You Can Do
|
||||||
|
|
||||||
### Image Processing (48 Tools)
|
### Image Processing (49 Tools)
|
||||||
|
|
||||||
| Category | Tools |
|
| Category | Tools |
|
||||||
|----------|-------|
|
|----------|-------|
|
||||||
|
|||||||
+2
-2
@@ -4,7 +4,7 @@ layout: home
|
|||||||
hero:
|
hero:
|
||||||
name: "SnapOtter"
|
name: "SnapOtter"
|
||||||
text: "A Self Hosted Image Manipulator"
|
text: "A Self Hosted Image Manipulator"
|
||||||
tagline: 48 tools. Local AI. No cloud. Your images never leave your home.
|
tagline: 49 tools. Local AI. No cloud. Your images never leave your home.
|
||||||
actions:
|
actions:
|
||||||
- theme: brand
|
- theme: brand
|
||||||
text: Get started
|
text: Get started
|
||||||
@@ -14,7 +14,7 @@ hero:
|
|||||||
link: /api/rest
|
link: /api/rest
|
||||||
|
|
||||||
features:
|
features:
|
||||||
- title: 48 Image Tools
|
- title: 49 Image Tools
|
||||||
details: Resize, crop, compress, convert, watermark, color adjust, vectorize, create GIFs, build collages, generate passport photos, find duplicates, and more.
|
details: Resize, crop, compress, convert, watermark, color adjust, vectorize, create GIFs, build collages, generate passport photos, find duplicates, and more.
|
||||||
- title: Local AI
|
- title: Local AI
|
||||||
details: 15 AI-powered tools - remove backgrounds, upscale, enhance images, restore and colorize old photos, erase objects, blur faces, enhance faces, extract text (OCR), fix fake transparency. All on your hardware, no internet required.
|
details: 15 AI-powered tools - remove backgrounds, upscale, enhance images, restore and colorize old photos, erase objects, blur faces, enhance faces, extract text (OCR), fix fake transparency. All on your hardware, no internet required.
|
||||||
|
|||||||
Reference in New Issue
Block a user