VideoEditRequest schema

FieldType and description
model
Required
string

Video editing model identifier.

video
Required
string

Source video file for editing.

format: "binary"

promptstring

Text prompt describing the edit (required for text_prompt mode).

maskstring

Mask video for region-based editing (mask_video mode).

format: "binary"

mask_urlstring

Public HTTPS URL to the mask video (alternative to uploading mask binary).

format: "uri"

key_pointsstring

JSON-encoded string representing an array of key-point objects for key_points mode. Each object must have numeric x, y coordinates and a type of either "positive" or "negative". Example: "[{\"x\":100,\"y\":200,\"type\":\"positive\"}]" The route calls JSON.parse() on this field before forwarding.

frame_indexinteger

Frame index for key_points editing mode.

default: 0

auto_trimboolean

Whether to auto-trim the output video.

default: false

preserve_audioboolean

Whether to preserve the original audio track in the output.

default: true

background_colorstring

Background fill color (background_color mode). CSS color name or hex value.

default: "White"

desired_increaseinteger

Upscale factor for upscale_factor mode. Only 2 or 4 are accepted; other values are coerced to 2.

Allowed values: [2,4]

default: 2

output_container_and_codecstring

Output container and codec string.