Example Usage
import { VideoGenerationRequest } from "@openrouter/sdk/models";
let value: VideoGenerationRequest = {
model: "google/veo-3.1",
};
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
aspectRatio | models.VideoGenerationRequestAspectRatio | :heavy_minus_sign: | Aspect ratio of the generated video | 16:9 |
callbackUrl | string | :heavy_minus_sign: | URL to receive a webhook notification when the video generation job completes. Overrides the workspace-level default callback URL if set. Must be HTTPS. | https://example.com/webhook |
duration | number | :heavy_minus_sign: | Duration of the generated video in seconds | 8 |
frameImages | models.FrameImage[] | :heavy_minus_sign: | Images to use as the first and/or last frame of the generated video. Each image must specify a frame_type of first_frame or last_frame. | |
generateAudio | boolean | :heavy_minus_sign: | Whether to generate audio alongside the video. Defaults to the endpoint’s generate_audio capability flag, false if not set. | true |
inputReferences | models.InputReference[] | :heavy_minus_sign: | Reference assets to guide video generation. Accepts image, audio, and video references. Audio and video references are only honored by providers that support them (currently BytePlus Seedance 2.0); other providers use image references and ignore the rest. | |
model | string | :heavy_check_mark: | N/A | |
prompt | string | :heavy_minus_sign: | Text prompt describing the video to generate. Optional for models that support generating a video from image input alone; required by all other models. | A serene mountain landscape at sunset |
provider | models.VideoGenerationRequestProvider | :heavy_minus_sign: | Provider-specific passthrough configuration | |
resolution | models.VideoGenerationRequestResolution | :heavy_minus_sign: | Resolution of the generated video | 720p |
seed | number | :heavy_minus_sign: | If specified, the generation will sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed for all providers. | |
size | string | :heavy_minus_sign: | Exact pixel dimensions of the generated video in “WIDTHxHEIGHT” format (e.g. “1280x720”). Interchangeable with resolution + aspect_ratio. | 1280x720 |