Skip to main content

Interface: VideoGenerateRequest

Defined in: packages/agentos/src/io/media/video/types.ts:127

Request payload for text-to-video generation.

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

Properties​

aspectRatio?​

optional aspectRatio: VideoAspectRatio

Defined in: packages/agentos/src/io/media/video/types.ts:137

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


durationSec?​

optional durationSec: number

Defined in: packages/agentos/src/io/media/video/types.ts:135

Desired output duration in seconds.


fps?​

optional fps: number

Defined in: packages/agentos/src/io/media/video/types.ts:152

Frames per second for the output video.


modelId?​

optional modelId: string

Defined in: packages/agentos/src/io/media/video/types.ts:129

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


n?​

optional n: number

Defined in: packages/agentos/src/io/media/video/types.ts:156

Number of videos to generate. Defaults to 1.


negativePrompt?​

optional negativePrompt: string

Defined in: packages/agentos/src/io/media/video/types.ts:133

Negative prompt describing content to avoid.


outputFormat?​

optional outputFormat: VideoOutputFormat

Defined in: packages/agentos/src/io/media/video/types.ts:150

Output container format. Defaults to 'mp4'.


prompt​

prompt: string

Defined in: packages/agentos/src/io/media/video/types.ts:131

Text prompt describing the desired video content.


providerOptions?​

optional providerOptions: Record<string, unknown> | VideoProviderOptionBag

Defined in: packages/agentos/src/io/media/video/types.ts:163

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


referenceImages?​

optional referenceImages: VideoImageInput[]

Defined in: packages/agentos/src/io/media/video/types.ts:148

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.


resolution?​

optional resolution: string

Defined in: packages/agentos/src/io/media/video/types.ts:142

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


seed?​

optional seed: number

Defined in: packages/agentos/src/io/media/video/types.ts:154

Seed for reproducible output.


userId?​

optional userId: string

Defined in: packages/agentos/src/io/media/video/types.ts:158

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