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

Files

T

SnapOtter 8532f3227b docs: audit all 157 tool pages against live schemas

Reconcile every tool page's parameters, defaults, and response shape against the tool's Zod settings schema and executionHint in code. Notable fixes: color-palette (add count + format params, hex output, median-cut algorithm), favicon (add 5 params, was documented as having none), qr-generate (add logoDataUri), convert (add ppm/eps/tga formats), video-loudnorm (-16 LUFS not -14), smart-crop (async 202 not sync 200), images-to-video (1080x1080 square), and several output-filename and behavior-note corrections.

Also normalize API endpoint paths to /api/v1/tools/<id> (no modality segment) and standardize curl examples on the Docker API port 1349. Verified with a clean docs build.

2026-06-18 14:12:28 +08:00

2.0 KiB

Raw Blame History

description

description
Replace image background with a solid color or gradient using AI.

Background Replace

Replace the background of an image with a solid color or gradient. The AI model detects the subject, removes the original background, and composites the subject onto your chosen background.

API Endpoint

POST /api/v1/tools/background-replace

Accepts multipart form data with an image file and a JSON settings field.

Parameters

Parameter	Type	Required	Default	Description
backgroundType	string	No	`"color"`	Background mode: `color` or `gradient`
color	string	No	`"#ffffff"`	Background hex color (when backgroundType is `color`)
gradientColor1	string	No	-	First gradient hex color
gradientColor2	string	No	-	Second gradient hex color
gradientAngle	integer	No	`180`	Gradient angle in degrees (0-360)
feather	integer	No	`0`	Edge feathering radius (0-20)
format	string	No	`"png"`	Output format: `png` or `webp`

Example Request

curl -X POST http://localhost:1349/api/v1/tools/background-replace \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@photo.jpg" \
  -F 'settings={"backgroundType": "color", "color": "#2563eb", "feather": 2}'

Example Response

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "async": true
}

Track progress via SSE at GET /api/v1/jobs/{jobId}/progress. When the job completes, the SSE stream emits a completed event with the download URL.

Notes

This is an AI-powered tool that returns 202 Accepted and processes asynchronously. Connect to the SSE endpoint to receive progress updates and the final result.
Requires the background-removal feature bundle to be installed. Returns 501 if the bundle is not available.
HEIC, RAW, PSD, and SVG inputs are automatically decoded before processing.
Output defaults to PNG to preserve transparency around the subject.

2.0 KiB Raw Blame History