Files
SnapOtter/apps/docs/ja/tools/image/remove-background.md
T
SnapOtterandGitHub 4963ab3bbd feat(docs-i18n): translate all documentation into 20 languages
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.
2026-07-11 13:52:47 +08:00

5.6 KiB
Raw Blame History

description, i18n_source_hash, i18n_provenance, i18n_output_hash
description i18n_source_hash i18n_provenance i18n_output_hash
任意のエフェクト(ぼかし、影、グラデーション、カスタム背景)を備えた AI 背景除去。 326a91284529 human 7c5bacf509f7

背景除去

任意のエフェクト(ぼかし、影、グラデーション、カスタム背景)を備えた AI 背景除去。

API エンドポイント

POST /api/v1/tools/image/remove-background

処理: 非同期(202 を返し、SSE 経由で /api/v1/jobs/{jobId}/progress をポーリングしてステータスを取得)

モデルバンドル: background-removal45 GB

パラメーター

パラメーター 必須 デフォルト 説明
file file Yes - 画像ファイル(マルチパート)
model string No - 使用する AI モデルのバリアント
backgroundType string No "transparent" 次のいずれか: transparent, color, gradient, blur, image
backgroundColor string No - 単色背景の 16 進カラー
gradientColor1 string No - グラデーションの 1 色目
gradientColor2 string No - グラデーションの 2 色目
gradientAngle number No - グラデーションの角度(度)
blurEnabled boolean No - 背景ぼかし効果を有効にする
blurIntensity number No - ぼかしの強度(0100
shadowEnabled boolean No - 被写体にドロップシャドウを有効にする
shadowOpacity number No - 影の不透明度(0100
outputFormat string No - 出力フォーマット: png, webp, または avif
edgeRefine integer No - エッジの精細化レベル(03
decontaminate boolean No - エッジの色にじみを除去する

リクエスト例

curl -X POST http://localhost:1349/api/v1/tools/image/remove-background \
  -F "file=@photo.jpg" \
  -F 'settings={"backgroundType":"transparent","edgeRefine":2,"outputFormat":"png"}'

レスポンス

初期レスポンス(202 Accepted

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

進捗(/api/v1/jobs/{jobId}/progress の SSE

event: progress
data: {"phase":"processing","stage":"Removing background...","percent":50}

最終結果(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"
  }
}

エフェクトエンドポイント(フェーズ 2)

POST /api/v1/tools/image/remove-background/effects

AI モデルを再実行せずに背景エフェクトを再適用します。フェーズ 1 のキャッシュされたマスクと元画像を使用します。

パラメーター

パラメーター 必須 デフォルト 説明
settings JSON Yes - エフェクト設定を含む JSON(下記参照)
backgroundImage file No - カスタム背景画像(backgroundType が image の場合)

settings JSON のフィールド

フィールド 必須 説明
jobId string Yes フェーズ 1 のジョブ ID
filename string Yes フェーズ 1 の元のファイル名
backgroundType string No transparent, color, gradient, blur, image
backgroundColor string No 単色背景の 16 進カラー
gradientColor1 string No グラデーションの 1 色目
gradientColor2 string No グラデーションの 2 色目
gradientAngle number No グラデーションの角度(度)
blurEnabled boolean No 背景ぼかしを有効にする
blurIntensity number No ぼかしの強度(0100
shadowEnabled boolean No ドロップシャドウを有効にする
shadowOpacity number No 影の不透明度(0100
outputFormat string No png, webp, または avif

リクエスト例

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"}'

レスポンス(200 OK

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "downloadUrl": "/api/v1/download/{jobId}/photo_nobg.png",
  "processedSize": 195000
}

注意事項

  • background-removal モデルバンドル(4~5 GB)のインストールが必要です。
  • フェーズ 1 は透明マスクと元画像をキャッシュするため、フェーズ 2(エフェクト)では AI モデルを再実行せずに、異なる背景を即座に再適用できます。
  • HEIC/HEIF、RAW、TGA、PSD、EXR、HDR の入力フォーマットを自動デコードでサポートします。
  • 処理前に EXIF の回転が自動補正されます。