Skip to main content

Interface: BackgroundRemovalRequest

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

Normalized provider-level request produced by removeBackground from RemoveBackgroundOptions: the image is an http(s) URL or a data URL, and every default is filled in.

Properties​

format​

format: BackgroundRemovalFormat

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


imageUrl​

imageUrl: string

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

The source image as an http(s) URL or a base64 data URL.


modelId​

modelId: string

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

The model or endpoint; empty for the provider's default.


output​

output: BackgroundRemovalOutput

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


providerOptions?​

optional providerOptions: Record<string, unknown> | BackgroundRemovalProviderOptionBag

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


returnMask​

returnMask: boolean

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


signal?​

optional signal: AbortSignal

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


timeoutMs​

timeoutMs: number

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

The call's deadline in milliseconds.