Open History to see the last commit
1---
2id: generateVideo
3title: generateVideo
4---
5
6# Function: generateVideo()
7
8```ts
9function generateVideo<TAdapter>(options): Promise<VideoJobResult>;
10```
11
12Defined in: [activities/generateVideo/index.ts:158](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/index.ts#L158)
13
14**`Experimental`**
15
16Generate video - creates a video generation job from a text prompt.
17
18Uses AI video generation models to create videos based on natural language descriptions.
19Unlike image generation, video generation is asynchronous and requires polling for completion.
20
21 Video generation is an experimental feature and may change.
22
23## Type Parameters
24
25### TAdapter
26
27`TAdapter` *extends* [`VideoAdapter`](../interfaces/VideoAdapter.md)\<`string`, `object`\>
28
29## Parameters
30
31### options
32
33`VideoCreateOptions`\<`TAdapter`\>
34
35## Returns
36
37`Promise`\<[`VideoJobResult`](../interfaces/VideoJobResult.md)\>
38
39## Example
40
41```ts
42import { generateVideo } from '@tanstack/ai'
43import { openaiVideo } from '@tanstack/ai-openai'
44
45// Start a video generation job
46const { jobId } = await generateVideo({
47 adapter: openaiVideo('sora-2'),
48 prompt: 'A cat chasing a dog in a sunny park'
49})
50
51console.log('Job started:', jobId)
52```