VideoGenerationOptions

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

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

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:2627

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:2614

Video duration. Adapters that declare a per-model duration map narrow this to that model's union (a number, "8", or "8s"). Use adapter.snapDuration(input) to coerce a raw value. input may be seconds, a "6s" template, or "auto" when the model lists it.

logger

logger: InternalLogger;

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

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:2596

The model to use for video generation

modelOptions?

optional modelOptions?: TProviderOptions;

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

Model-specific options for video generation

prompt

prompt: MediaPrompt;

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

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.