Skip to main content
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Example Usage

import { VideoModel } from "@openrouter/sdk/models";

let value: VideoModel = {
  allowedPassthroughParameters: [],
  canonicalSlug: "google/veo-3.1",
  created: 1700000000,
  generateAudio: true,
  id: "google/veo-3.1",
  name: "Veo 3.1",
  seed: null,
  supportedAspectRatios: [
    "16:9",
  ],
  supportedDurations: [
    5,
    8,
  ],
  supportedFrameImages: [
    "first_frame",
    "last_frame",
  ],
  supportedResolutions: [
    "720p",
  ],
  supportedSizes: null,
};

Fields

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