`experimental_generateVideo()`

Video generation is an experimental feature. The API may change in future versions.

Generates videos based on a given prompt using a video model.

It is ideal for use cases where you need to generate videos programmatically, such as creating visual content, animations, or generating videos from images.

import { experimental_generateVideo as generateVideo } from 'ai';

const { videos } = await generateVideo({
  model: "google/veo-3.1-generate-001",
  prompt: 'A cat walking on a treadmill',
  aspectRatio: '16:9',
});

console.log(videos);

Import

import { experimental_generateVideo } from "ai"

API Signature

Parameters

model:

VideoModelV3

prompt:

string | GenerateVideoPrompt

object

image:

DataContent

text:

string

n?:

number

aspectRatio?:

string

resolution?:

string

duration?:

number

fps?:

number

seed?:

number

providerOptions?:

ProviderOptions

maxVideosPerCall?:

number

maxRetries?:

number

abortSignal?:

AbortSignal

headers?:

Record<string, string>

download?:

(options: { url: URL; abortSignal?: AbortSignal }) => Promise<{ data: Uint8Array; mediaType: string | undefined }>

Returns

video:

GeneratedFile

base64:

string

uint8Array:

Uint8Array

mediaType:

string

videos:

Array<GeneratedFile>

GeneratedFile

base64:

string

uint8Array:

Uint8Array

mediaType:

string

warnings:

Warning[]

providerMetadata?:

VideoModelProviderMetadata

responses:

Array<VideoModelResponseMetadata>

VideoModelResponseMetadata

timestamp:

Date

modelId:

string

headers?:

Record<string, string>

providerMetadata?:

VideoModelProviderMetadata