Interface: VideoGenerationOptions<TProviderOptions, TSize, TDuration>

Defined in: packages/ai/src/types.ts:2126

Experimental

Options for video generation. These are the common options supported across providers.

Video generation is an experimental feature and may change.

Type Parameters

TProviderOptions

TProviderOptions extends object = object

TSize

TSize extends string | undefined = string

TDuration

TDuration extends string | number | undefined = number

Properties

abortSignal?

optional abortSignal?: AbortSignal;

Defined in: packages/ai/src/types.ts:2162

Experimental

Effective abort signal composed by the activity from caller abortSignal and/or timeout. Adapters should forward this to the provider SDK when supported. Request-specific — never store on a global client config.

duration?

optional duration?: TDuration;

Defined in: packages/ai/src/types.ts:2149

Experimental

Video duration in seconds. Adapters that declare a per-model duration map narrow this to the model's valid union; use adapter.snapDuration(seconds) to coerce raw seconds to a valid value.

logger

logger: InternalLogger;

Defined in: packages/ai/src/types.ts:2156

Experimental

Internal logger threaded from the generateVideo() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in catch blocks.

model

model: string;

Defined in: packages/ai/src/types.ts:2132

Experimental

The model to use for video generation

modelOptions?

optional modelOptions?: TProviderOptions;

Defined in: packages/ai/src/types.ts:2151

Experimental

Model-specific options for video generation

prompt

prompt: MediaPrompt;

Defined in: packages/ai/src/types.ts:2141

Experimental

Description of the desired video: a plain string, or an ordered array of content parts for image-conditioned generation. Image parts may carry metadata.role ('start_frame' | 'end_frame' | 'reference' | 'character') to disambiguate intent; adapters route them onto the provider-native request (e.g. OpenAI Sora input_reference, fal image_url / end_image_url) and throw at runtime if unsupported.