Yapper Docs
Models & Inputs

Background removal

Cut the subject out of an image as a transparent PNG.

POST /api/v1/processes with "type": "background-removal". Pick any model — the API does not plan-gate models. GET /api/v1/models returns the same capabilities at runtime.

Input fields

FieldTypeRequiredDescription
disableAutoRetriesbooleannoDisable automatic same-model retries. Defaults to false, so automatic retries are enabled.
imageUrlstringnoPublic image URL — imported into your asset library automatically, then processed. Alternative to imageAssetId.
imageAssetIdstringnoTeam image asset id from /assets. Required unless imageUrl is provided.
outputNamestringnoName for the output asset, up to 80 characters. It is stored as a lowercase hyphenated slug ("ORD-17 Concept A" becomes ord-17-concept-a), so use metadata for exact identifiers.

Example

Add "dryRun": true to get the exact credit cost without starting, and always send an Idempotency-Key header on real starts.

POST /api/v1/processes
{
  "type": "background-removal",
  "model": "bria-image-background-remover",
  "input": {
    "imageAssetId": "image_asset_id"
  }
}

Models

Cost depends on the input — use dryRun: true for an exact quote.

ModelNameDescriptionmodelOptions
bria-image-background-removerBackground RemovalRemove the background from your image—

On this page