mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
All 181 docs markdown files translated into 20 languages (apps/docs/<locale>/**). Companion to the i18n code PR; admin-merged because the file count exceeds GitHub's per-PR CI trigger limit. Validated by pnpm i18n:check (all surfaces, 0 stale/missing) and a clean all-locale docs build.
5.2 KiB
5.2 KiB
description, i18n_source_hash, i18n_provenance, i18n_output_hash
| description | i18n_source_hash | i18n_provenance | i18n_output_hash |
|---|---|---|---|
| KI-gestützte Hintergrundentfernung mit optionalen Effekten (Weichzeichnen, Schatten, Verlauf, eigener Hintergrund). | 326a91284529 | human | 4d349feb23a9 |
Hintergrund entfernen
KI-gestützte Hintergrundentfernung mit optionalen Effekten (Weichzeichnen, Schatten, Verlauf, eigener Hintergrund).
API-Endpunkt
POST /api/v1/tools/image/remove-background
Verarbeitung: Asynchron (gibt 202 zurück, Status über SSE per /api/v1/jobs/{jobId}/progress abfragen)
Modell-Bundle: background-removal (4-5 GB)
Parameter
| Parameter | Typ | Erforderlich | Standard | Beschreibung |
|---|---|---|---|---|
| file | file | Ja | - | Bilddatei (multipart) |
| model | string | Nein | - | Zu verwendende KI-Modellvariante |
| backgroundType | string | Nein | "transparent" |
Eines von: transparent, color, gradient, blur, image |
| backgroundColor | string | Nein | - | Hex-Farbe für einfarbigen Hintergrund |
| gradientColor1 | string | Nein | - | Erste Verlaufsfarbe |
| gradientColor2 | string | Nein | - | Zweite Verlaufsfarbe |
| gradientAngle | number | Nein | - | Verlaufswinkel in Grad |
| blurEnabled | boolean | Nein | - | Hintergrund-Weichzeichnungseffekt aktivieren |
| blurIntensity | number | Nein | - | Weichzeichnungsintensität (0-100) |
| shadowEnabled | boolean | Nein | - | Schlagschatten auf dem Motiv aktivieren |
| shadowOpacity | number | Nein | - | Deckkraft des Schattens (0-100) |
| outputFormat | string | Nein | - | Ausgabeformat: png, webp oder avif |
| edgeRefine | integer | Nein | - | Stufe der Kantenverfeinerung (0-3) |
| decontaminate | boolean | Nein | - | Farbüberläufe an den Kanten entfernen |
Beispielanfrage
curl -X POST http://localhost:1349/api/v1/tools/image/remove-background \
-F "file=@photo.jpg" \
-F 'settings={"backgroundType":"transparent","edgeRefine":2,"outputFormat":"png"}'
Antwort
Erste Antwort (202 Accepted)
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"async": true
}
Fortschritt (SSE unter /api/v1/jobs/{jobId}/progress)
event: progress
data: {"phase":"processing","stage":"Removing background...","percent":50}
Endergebnis (über SSE)
{
"phase": "complete",
"percent": 100,
"result": {
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"downloadUrl": "/api/v1/download/{jobId}/photo_mask.png",
"maskUrl": "/api/v1/download/{jobId}/photo_mask.png",
"originalUrl": "/api/v1/download/{jobId}/photo_original.png",
"originalSize": 245000,
"processedSize": 180000,
"filename": "photo.jpg",
"model": "rembg"
}
}
Effekt-Endpunkt (Phase 2)
POST /api/v1/tools/image/remove-background/effects
Wendet Hintergrundeffekte erneut an, ohne das KI-Modell neu auszuführen. Verwendet die zwischengespeicherte Maske und das Original aus Phase 1.
Parameter
| Parameter | Typ | Erforderlich | Standard | Beschreibung |
|---|---|---|---|---|
| settings | JSON | Ja | - | JSON mit Effekteinstellungen (siehe unten) |
| backgroundImage | file | Nein | - | Eigenes Hintergrundbild (wenn backgroundType image ist) |
JSON-Felder der Einstellungen
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| jobId | string | Ja | Job-ID aus Phase 1 |
| filename | string | Ja | Ursprünglicher Dateiname aus Phase 1 |
| backgroundType | string | Nein | transparent, color, gradient, blur, image |
| backgroundColor | string | Nein | Hex-Farbe für einfarbigen Hintergrund |
| gradientColor1 | string | Nein | Erste Verlaufsfarbe |
| gradientColor2 | string | Nein | Zweite Verlaufsfarbe |
| gradientAngle | number | Nein | Verlaufswinkel in Grad |
| blurEnabled | boolean | Nein | Hintergrund-Weichzeichnung aktivieren |
| blurIntensity | number | Nein | Weichzeichnungsintensität (0-100) |
| shadowEnabled | boolean | Nein | Schlagschatten aktivieren |
| shadowOpacity | number | Nein | Deckkraft des Schattens (0-100) |
| outputFormat | string | Nein | png, webp oder avif |
Beispielanfrage
curl -X POST http://localhost:1349/api/v1/tools/image/remove-background/effects \
-F 'settings={"jobId":"a1b2c3d4-...","filename":"photo.jpg","backgroundType":"color","backgroundColor":"#FF5500","outputFormat":"png"}'
Antwort (200 OK)
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"downloadUrl": "/api/v1/download/{jobId}/photo_nobg.png",
"processedSize": 195000
}
Hinweise
- Erfordert das installierte Modell-Bundle
background-removal(4-5 GB). - Phase 1 speichert die transparente Maske und das Originalbild zwischen, sodass Phase 2 (Effekte) verschiedene Hintergründe sofort erneut anwenden kann, ohne das KI-Modell neu auszuführen.
- Unterstützt die Eingabeformate HEIC/HEIF, RAW, TGA, PSD, EXR und HDR durch automatische Dekodierung.
- Die EXIF-Rotation wird vor der Verarbeitung automatisch korrigiert.