Tools

Remove background from an image

Remove the background from an image, returning a transparent-background PNG of the foreground subject.

post/v1/tools/remove-image-background

Request body

imageFileIdstring required

File id of the source image (e.g. vg_file_...). Upload a file first via POST /v1/files/upload, then pass the returned id here.

watermarkMode'NONE' | 'VIDEO_GEN' | 'AUTO'

Controls whether the VideoGen watermark is applied to the output. AUTO applies the watermark unless you have a Pro plan. VIDEO_GEN always applies it. NONE removes the watermark (requires Pro; returns an error if you don't have it).

numResultsinteger

Number of output results to generate. Defaults to 1.

isOutputTemporaryboolean

When true, generated files are temporary. Temporary files are guaranteed to be available for 24 hours, after which they may be archived at any time. Temporary files are not analyzed (no description, transcript, or embedding will be generated), so they will not appear in search results. Defaults to false.

hideFromUiboolean

When true, generated files are hidden from the VideoGen Media page by default. They remain accessible through the API. Defaults to false.

Response

Execution accepted; poll until complete.

toolExecutionIdstring required

Execution id (e.g. vg_tool_...).

Changes

No recorded changes to this endpoint across all 1 revision of this API.