--- title: experimental_generateVideo description: API Reference for experimental_generateVideo. --- # `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. ```ts import { experimental_generateVideo as generateVideo } from 'ai'; __PROVIDER_IMPORT__; const { videos } = await generateVideo({ model: __VIDEO_MODEL__, prompt: 'A cat walking on a treadmill', aspectRatio: '16:9', }); console.log(videos); ``` ## Import ## API Signature ### Parameters ', isOptional: true, description: 'Additional HTTP headers for the request.', }, { name: 'download', type: '(options: { url: URL; abortSignal?: AbortSignal }) => Promise<{ data: Uint8Array; mediaType: string | undefined }>', isOptional: true, description: 'Custom download function for fetching videos from URLs. Use `createDownload()` from `ai` to create a download function with custom size limits, e.g. `createDownload({ maxBytes: 50 * 1024 * 1024 })`. Default: built-in download with 2 GiB limit.', }, ]} /> ### Returns ', description: 'All videos that were generated.', properties: [ { type: 'GeneratedFile', parameters: [ { name: 'base64', type: 'string', description: 'Video as a base64 encoded string.', }, { name: 'uint8Array', type: 'Uint8Array', description: 'Video as a Uint8Array.', }, { name: 'mediaType', type: 'string', description: 'The IANA media type of the video (e.g., video/mp4).', }, ], }, ], }, { name: 'warnings', type: 'Warning[]', description: 'Warnings from the model provider (e.g. unsupported settings).', }, { name: 'providerMetadata', type: 'VideoModelProviderMetadata', isOptional: true, description: 'Optional metadata from the provider. The outer key is the provider name. The inner values are the metadata. A `videos` key is typically present in the metadata and is an array with the same length as the top level `videos` key. Details depend on the provider.', }, { name: 'responses', type: 'Array', description: 'Response metadata from the provider. There may be multiple responses if we made multiple calls to the model.', properties: [ { type: 'VideoModelResponseMetadata', parameters: [ { name: 'timestamp', type: 'Date', description: 'Timestamp for the start of the generated response.', }, { name: 'modelId', type: 'string', description: 'The ID of the response model that was used to generate the response.', }, { name: 'headers', type: 'Record', isOptional: true, description: 'Response headers.', }, { name: 'providerMetadata', type: 'VideoModelProviderMetadata', isOptional: true, description: 'Provider-specific metadata for this individual API call. Useful for accessing per-call metadata when multiple calls are made.', }, ], }, ], }, ]} />