Remove Background - Dreep API Documentation

Uploads an image and stores a cutout of the subject with a transparent background as a new asset.

f, err := os.Open("shoe.png")
if err != nil {
    return err
}
defer f.Close()

result, err := client.RemoveBackground(ctx, f, "shoe.png", &dreep.RemoveBackgroundOptions{
    Destination: dreep.Destination{Folder: "products"},
})

Signature

func (c *Client) RemoveBackground(ctx context.Context, file io.Reader, filename string, o *dreep.RemoveBackgroundOptions) (*dreep.RemoveBackgroundResult, error)

Parameter	Type	Description
`file`	`io.Reader`	Required. The image to cut out
`filename`	`string`	Required. Name of the source file
`o`	`*dreep.RemoveBackgroundOptions`	Optional. Pass `nil` for defaults

`RemoveBackgroundOptions`

Field	Type	Description
`Format`	`dreep.Format`	Output format. PNG keeps transparency
`Destination`	`dreep.Destination`	Embedded. `Folder` or `FolderID`
`AutoCreateFolders`	`*bool`	Set `dreep.Ptr(false)` to require the path already exists

Returns

type RemoveBackgroundResult struct {
    Asset dreep.CutoutAsset // ID, StorageKey, URL, Format, Width, Height, SizeBytes
}

Serving it on a background

The alpha channel is preserved rather than flattened, so a single removal serves any number of background colours as ordinary transforms — and only the removal is billed.

white := client.URL(result.Asset.ID, &dreep.Transform{BG: "ffffff"})
black := client.URL(result.Asset.ID, &dreep.Transform{BG: "000000"})

Errors

Check	Cause
`dreep.IsPaymentRequired(err)`	No background-removal credits remain
`dreep.IsInvalidRequest(err)`	The file isn’t a supported image

Like every upload, this is never retried automatically.