For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
ModelsChatRankingsDocs
DocsAPI ReferenceClient SDKsAgent SDKCookbookChangelog
DocsAPI ReferenceClient SDKsAgent SDKCookbookChangelog
    • Overview
    • Usage for Agents
  • TypeScript SDK
    • Overview
      • Analytics
      • APIKeys
      • Byok
      • Chat
      • Credits
      • Embeddings
      • Endpoints
      • Generations
      • Guardrails
        • Models
        • VideoGenerationRequest
      • OAuth
      • Observability
      • Organization
      • Presets
      • Providers
      • Rerank
      • Beta.Responses
      • Transcriptions
      • Speech
      • VideoGeneration
      • Workspaces
  • Python SDK
    • Overview
  • Go SDK
  • DevTools
    • Overview
    • Migrating to @openrouter/agent
LogoLogo
ModelsChatRankingsDocs
On this page
  • Example Usage
  • Fields
TypeScript SDKAPI ReferenceModels

VideoGenerationRequest - TypeScript SDK

VideoGenerationRequest type definition
Was this page helpful?
Previous

OAuth - TypeScript SDK

OAuth method reference
Next
Built with

The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Example Usage

1import { VideoGenerationRequest } from "@openrouter/sdk/models";
2
3let value: VideoGenerationRequest = {
4 model: "google/veo-3.1",
5 prompt: "A serene mountain landscape at sunset",
6};

Fields

FieldTypeRequiredDescriptionExample
aspectRatiomodels.AspectRatio➖Aspect ratio of the generated video16:9
callbackUrlstring➖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
durationnumber➖Duration of the generated video in seconds8
frameImagesmodels.FrameImage[]➖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.
generateAudioboolean➖Whether to generate audio alongside the video. Defaults to the endpoint’s generate_audio capability flag, false if not set.true
inputReferencesmodels.ContentPartImage[]➖Reference images to guide video generation
modelstring✔️N/A
promptstring✔️N/A
providermodels.VideoGenerationRequestProvider➖Provider-specific passthrough configuration
resolutionmodels.Resolution➖Resolution of the generated video720p
seednumber➖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.
sizestring➖Exact pixel dimensions of the generated video in “WIDTHxHEIGHT” format (e.g. “1280x720”). Interchangeable with resolution + aspect_ratio.1280x720