Skip to content

Pixelcut Video Background Removal

POST/v1/run

Video Background Removal by Pixelcut - AI-powered video editing and transformation. Apply style transfer, motion control, lip-sync, and visual effects to existing videos with natural language instructions.

Request body

Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.

stringmodelrequired

Model identifier. Set to pixelcut/video-background-removal.

Default: pixelcut/video-background-removal

Optional<string>video

URL of the input video

Optional<string>output_format

Output video format. Auto-detected if not set (defaults to webm_vp9 for transparent).

Allowed values: webm_vp9, mp4_h264, mp4_h265, mov_proresks, mov_h265, mkv_h264, mkv_h265, mkv_vp9, gif

Optional<string>background_color

Custom solid background color (only used when background='custom').

Optional<string>background

Output background: transparent, a named preset color, or 'custom' to use the background_color color picker.

Allowed values: transparent, black, white, green, blue, magenta, custom

Default: transparent

Response Schema

The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

Optional<string>model

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: video-to-video

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async