Skip to main content

Interface: FalBackgroundRemovalOptions

Defined in: packages/agentos/src/io/segmentation/types.ts:172

Per-provider passthrough options for the fal background removal backend.

Properties​

input?​

optional input: Record<string, unknown>

Defined in: packages/agentos/src/io/segmentation/types.ts:188

Extra fields merged verbatim into the request body after the fields above (for example mask_only). The call's image (image_url), the mask returnMask asks for (output_mask) and the inline answer output: 'buffer' asks for (sync_mode) stand over them.


maxResponseBytes?​

optional maxResponseBytes: number

Defined in: packages/agentos/src/io/segmentation/types.ts:193

The most bytes read from fal's answer, and from a downloaded cut-out or mask; past it the call rejects with provider_failed. Default 64 MiB.


operatingResolution?​

optional operatingResolution: string & object | "1024x1024" | "2048x2048" | "2304x2304"

Defined in: packages/agentos/src/io/segmentation/types.ts:179

The resolution BiRefNet works at (operating_resolution). Default '1024x1024'; '2304x2304' runs on the General Use (Dynamic) variant only.


refineForeground?​

optional refineForeground: boolean

Defined in: packages/agentos/src/io/segmentation/types.ts:181

Refine the foreground with the estimated mask (refine_foreground). Default true.


variant?​

optional variant: string & object | FalBiRefNetVariant

Defined in: packages/agentos/src/io/segmentation/types.ts:174

The BiRefNet weights (the endpoint's model field). Default 'General Use (Light)'.