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
        • VideoModel
      • 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

VideoModel - TypeScript SDK

VideoModel 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 { VideoModel } from "@openrouter/sdk/models";
2
3let value: VideoModel = {
4 allowedPassthroughParameters: [],
5 canonicalSlug: "google/veo-3.1",
6 created: 1700000000,
7 generateAudio: true,
8 id: "google/veo-3.1",
9 name: "Veo 3.1",
10 seed: null,
11 supportedAspectRatios: [
12 "16:9",
13 ],
14 supportedDurations: [
15 5,
16 8,
17 ],
18 supportedFrameImages: [
19 "first_frame",
20 "last_frame",
21 ],
22 supportedResolutions: [
23 "720p",
24 ],
25 supportedSizes: null,
26};

Fields

FieldTypeRequiredDescriptionExample
allowedPassthroughParametersstring[]✔️List of parameters that are allowed to be passed through to the provider
canonicalSlugstring✔️Canonical slug for the modelopenai/gpt-4
creatednumber✔️Unix timestamp of when the model was created1692901234
descriptionstring➖Description of the modelGPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.
generateAudioboolean✔️Whether the model supports generating audio alongside video
huggingFaceIdstring➖Hugging Face model identifier, if applicablemicrosoft/DialoGPT-medium
idstring✔️Unique identifier for the modelopenai/gpt-4
namestring✔️Display name of the modelGPT-4
pricingSkusRecord<string, *string*>➖Pricing SKUs with provider prefix stripped, values as strings
seedboolean✔️Whether the model supports deterministic generation via seed parameter
supportedAspectRatiosmodels.SupportedAspectRatio[]✔️Supported output aspect ratios
supportedDurationsnumber[]✔️Supported video durations in seconds
supportedFrameImagesmodels.SupportedFrameImage[]✔️Supported frame image types (e.g. first_frame, last_frame)
supportedResolutionsmodels.SupportedResolution[]✔️Supported output resolutions
supportedSizesmodels.SupportedSize[]✔️Supported output sizes (width x height)