Interface VideoGenerateRequest

Request payload for text-to-video generation.

Passed to IVideoGenerator.generateVideo by the high-level orchestration layer after normalising user input.

interface VideoGenerateRequest {
    modelId?: string;
    prompt: string;
    negativePrompt?: string;
    durationSec?: number;
    aspectRatio?: VideoAspectRatio;
    resolution?: string;
    referenceImages?: VideoImageInput[];
    outputFormat?: VideoOutputFormat;
    fps?: number;
    seed?: number;
    n?: number;
    userId?: string;
    providerOptions?: Record<string, unknown> | VideoProviderOptionBag;
}

Properties

modelId? prompt negativePrompt? durationSec? aspectRatio? resolution? referenceImages? outputFormat? fps? seed? n? userId? providerOptions?

Properties

Optional modelId

modelId?: string

Model identifier to use for generation (e.g. 'gen-3-alpha').

prompt

prompt: string

Text prompt describing the desired video content.

Optional negativePrompt

negativePrompt?: string

Negative prompt describing content to avoid.

Optional durationSec

durationSec?: number

Desired output duration in seconds.

Optional aspectRatio

aspectRatio?: VideoAspectRatio

Desired aspect ratio (e.g. '16:9').

Optional resolution

resolution?: string

Desired output resolution, in the model's own vocabulary (for example '720p', '1080p', or fal's '768P' for MiniMax). Sent as given.

Optional referenceImages

referenceImages?: VideoImageInput[]

Images of subjects or assets the video must keep consistent (reference-to-video). Sent as fal's reference_image_urls, Replicate's reference_images, or Gemini image parts.

Optional outputFormat

outputFormat?: VideoOutputFormat

Output container format. Defaults to 'mp4'.

Optional fps

fps?: number

Frames per second for the output video.

Optional seed

seed?: number

Seed for reproducible output.

Optional n

n?: number

Number of videos to generate. Defaults to 1.

Optional userId

userId?: string

Identifier of the requesting user (for billing / rate limiting).

Optional providerOptions

providerOptions?: Record<string, unknown> | VideoProviderOptionBag

Provider-specific model inputs: a VideoProviderOptionBag keyed by provider id, or a flat object that fal, Replicate and Gemini receive whole.

Settings

Member Visibility

Theme

On This Page

modelIdpromptnegativePromptdurationSecaspectRatioresolutionreferenceImagesoutputFormatfpsseednuserIdproviderOptions