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.3 KiB
5.3 KiB
description, i18n_source_hash, i18n_provenance, i18n_output_hash
| description | i18n_source_hash | i18n_provenance | i18n_output_hash |
|---|---|---|---|
| Eliminación de fondo con IA con efectos opcionales (desenfoque, sombra, degradado, fondo personalizado). | 326a91284529 | human | e355ac762afd |
Eliminar fondo
Eliminación de fondo con IA con efectos opcionales (desenfoque, sombra, degradado, fondo personalizado).
Endpoint de la API
POST /api/v1/tools/image/remove-background
Procesamiento: asíncrono (devuelve 202, consulta /api/v1/jobs/{jobId}/progress para conocer el estado vía SSE)
Paquete del modelo: background-removal (4-5 GB)
Parámetros
| Parámetro | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
| file | file | Sí | - | Archivo de imagen (multipart) |
| model | string | No | - | Variante del modelo de IA que se usará |
| backgroundType | string | No | "transparent" |
Uno de: transparent, color, gradient, blur, image |
| backgroundColor | string | No | - | Color hexadecimal para fondo sólido |
| gradientColor1 | string | No | - | Primer color del degradado |
| gradientColor2 | string | No | - | Segundo color del degradado |
| gradientAngle | number | No | - | Ángulo del degradado en grados |
| blurEnabled | boolean | No | - | Habilitar el efecto de desenfoque de fondo |
| blurIntensity | number | No | - | Intensidad del desenfoque (0-100) |
| shadowEnabled | boolean | No | - | Habilitar la sombra paralela sobre el sujeto |
| shadowOpacity | number | No | - | Opacidad de la sombra (0-100) |
| outputFormat | string | No | - | Formato de salida: png, webp o avif |
| edgeRefine | integer | No | - | Nivel de refinamiento de bordes (0-3) |
| decontaminate | boolean | No | - | Eliminar el sangrado de color de los bordes |
Ejemplo de solicitud
curl -X POST http://localhost:1349/api/v1/tools/image/remove-background \
-F "file=@photo.jpg" \
-F 'settings={"backgroundType":"transparent","edgeRefine":2,"outputFormat":"png"}'
Respuesta
Respuesta inicial (202 Accepted)
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"async": true
}
Progreso (SSE en /api/v1/jobs/{jobId}/progress)
event: progress
data: {"phase":"processing","stage":"Removing background...","percent":50}
Resultado final (vía 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"
}
}
Endpoint de efectos (Fase 2)
POST /api/v1/tools/image/remove-background/effects
Vuelve a aplicar los efectos de fondo sin volver a ejecutar el modelo de IA. Usa la máscara y el original en caché de la Fase 1.
Parámetros
| Parámetro | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
| settings | JSON | Sí | - | JSON con los ajustes de los efectos (ver más abajo) |
| backgroundImage | file | No | - | Imagen de fondo personalizada (cuando backgroundType es image) |
Campos del JSON de ajustes
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| jobId | string | Sí | ID de trabajo de la Fase 1 |
| filename | string | Sí | Nombre de archivo original de la Fase 1 |
| backgroundType | string | No | transparent, color, gradient, blur, image |
| backgroundColor | string | No | Color hexadecimal para fondo sólido |
| gradientColor1 | string | No | Primer color del degradado |
| gradientColor2 | string | No | Segundo color del degradado |
| gradientAngle | number | No | Ángulo del degradado en grados |
| blurEnabled | boolean | No | Habilitar el desenfoque de fondo |
| blurIntensity | number | No | Intensidad del desenfoque (0-100) |
| shadowEnabled | boolean | No | Habilitar la sombra paralela |
| shadowOpacity | number | No | Opacidad de la sombra (0-100) |
| outputFormat | string | No | png, webp o avif |
Ejemplo de solicitud
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"}'
Respuesta (200 OK)
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"downloadUrl": "/api/v1/download/{jobId}/photo_nobg.png",
"processedSize": 195000
}
Notas
- Requiere que el paquete del modelo
background-removalesté instalado (4-5 GB). - La Fase 1 almacena en caché la máscara transparente y la imagen original para que la Fase 2 (efectos) pueda volver a aplicar distintos fondos al instante sin volver a ejecutar el modelo de IA.
- Admite los formatos de entrada HEIC/HEIF, RAW, TGA, PSD, EXR y HDR mediante decodificación automática.
- La rotación EXIF se corrige automáticamente antes del procesamiento.