Interface: ImageToVideoRequest
Defined in: packages/agentos/src/io/media/video/types.ts:173
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?
optionalaspectRatio:VideoAspectRatio
Defined in: packages/agentos/src/io/media/video/types.ts:191
Desired aspect ratio.
durationSec?
optionaldurationSec:number
Defined in: packages/agentos/src/io/media/video/types.ts:189
Desired output duration in seconds.
fps?
optionalfps:number
Defined in: packages/agentos/src/io/media/video/types.ts:206
Frames per second for the output video.
image
image:
VideoImageInput
Defined in: packages/agentos/src/io/media/video/types.ts:183
Source image (the first frame): raw bytes, an https:// URL or a data:
URL. See VideoImageInput for how each provider sends it. A custom
provider that sends a URL can pass it through videoImageToUrl() (from
the video index), which leaves a string as it is and turns a Buffer into
a data: URL. A string reaches a provider only when the caller passed one.
modelId?
optionalmodelId:string
Defined in: packages/agentos/src/io/media/video/types.ts:175
Model identifier to use for generation.
negativePrompt?
optionalnegativePrompt:string
Defined in: packages/agentos/src/io/media/video/types.ts:187
Negative prompt describing content to avoid.
outputFormat?
optionaloutputFormat:VideoOutputFormat
Defined in: packages/agentos/src/io/media/video/types.ts:204
Output container format. Defaults to 'mp4'.
prompt
prompt:
string
Defined in: packages/agentos/src/io/media/video/types.ts:185
Text prompt describing the desired motion / narrative.
providerOptions?
optionalproviderOptions:Record<string,unknown> |VideoProviderOptionBag
Defined in: packages/agentos/src/io/media/video/types.ts:215
Provider-specific model inputs: a VideoProviderOptionBag keyed by provider id, or a flat object that fal, Replicate and Gemini receive whole.
referenceImages?
optionalreferenceImages:VideoImageInput[]
Defined in: packages/agentos/src/io/media/video/types.ts:202
Images of subjects or assets the video must keep consistent, besides the
source image. Sent as fal's reference_image_urls, Replicate's
reference_images, or Gemini image parts after the source image.
resolution?
optionalresolution:string
Defined in: packages/agentos/src/io/media/video/types.ts:196
Desired output resolution, in the model's own vocabulary (for example
'720p', '1080p', or fal's '768P' for MiniMax). Sent as given.
seed?
optionalseed:number
Defined in: packages/agentos/src/io/media/video/types.ts:208
Seed for reproducible output.
userId?
optionaluserId:string
Defined in: packages/agentos/src/io/media/video/types.ts:210
Identifier of the requesting user.