Skip to main content

Interface: ImageToVideoRequest

Defined in: packages/agentos/src/core/video/types.ts:112

Request payload for image-to-video generation.

Passed to IVideoGenerator.imageToVideo by the high-level orchestration layer. Requires a source image that serves as the first frame (or style reference) for the generated video.

Properties

aspectRatio?

optional aspectRatio: VideoAspectRatio

Defined in: packages/agentos/src/core/video/types.ts:124

Desired aspect ratio.


durationSec?

optional durationSec: number

Defined in: packages/agentos/src/core/video/types.ts:122

Desired output duration in seconds.


fps?

optional fps: number

Defined in: packages/agentos/src/core/video/types.ts:128

Frames per second for the output video.


image

image: Buffer

Defined in: packages/agentos/src/core/video/types.ts:116

Source image as a raw Buffer.


modelId

modelId: string

Defined in: packages/agentos/src/core/video/types.ts:114

Model identifier to use for generation.


negativePrompt?

optional negativePrompt: string

Defined in: packages/agentos/src/core/video/types.ts:120

Negative prompt describing content to avoid.


outputFormat?

optional outputFormat: VideoOutputFormat

Defined in: packages/agentos/src/core/video/types.ts:126

Output container format. Defaults to 'mp4'.


prompt

prompt: string

Defined in: packages/agentos/src/core/video/types.ts:118

Text prompt describing the desired motion / narrative.


providerOptions?

optional providerOptions: Record<string, unknown>

Defined in: packages/agentos/src/core/video/types.ts:134

Arbitrary provider-specific options.


seed?

optional seed: number

Defined in: packages/agentos/src/core/video/types.ts:130

Seed for reproducible output.


userId?

optional userId: string

Defined in: packages/agentos/src/core/video/types.ts:132

Identifier of the requesting user.