Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

generateVideo.md

73 lines2.0 KB

1---
2id: generateVideo
3title: generateVideo
4---
5​
6# Function: generateVideo()
7​
8```ts
9function generateVideo<TAdapter, TStream>(options): TStream extends true ? AsyncIterable<AGUIEvent, any, any> : Promise<VideoJobResult>;
10```
11​
12Defined in: [packages/typescript/ai/src/activities/generateVideo/index.ts:231](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/index.ts#L231)
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​
21When `stream: true` is passed, handles the full job lifecycle automatically:
22create job → poll for status → stream updates → yield final result.
23​
24 Video generation is an experimental feature and may change.
25​
26## Type Parameters
27​
28### TAdapter
29​
30`TAdapter` *extends* [`VideoAdapter`](../interfaces/VideoAdapter.md)\<`string`, `any`, `any`, `any`\>
31​
32### TStream
33​
34`TStream` *extends* `boolean` = `false`
35​
36## Parameters
37​
38### options
39​
40`VideoCreateOptions`\<`TAdapter`, `TStream`\>
41​
42## Returns
43​
44`TStream` *extends* `true` ? `AsyncIterable`\<[`AGUIEvent`](../type-aliases/AGUIEvent.md), `any`, `any`\> : `Promise`\<[`VideoJobResult`](../interfaces/VideoJobResult.md)\>
45​
46## Examples
47​
48```ts
49import { generateVideo } from '@tanstack/ai'
50import { openaiVideo } from '@tanstack/ai-openai'
51​
52// Start a video generation job
53const { jobId } = await generateVideo({
54 adapter: openaiVideo('sora-2'),
55 prompt: 'A cat chasing a dog in a sunny park'
56})
57​
58console.log('Job started:', jobId)
59```
60​
61```ts
62import { generateVideo, toServerSentEventsResponse } from '@tanstack/ai'
63import { openaiVideo } from '@tanstack/ai-openai'
64​
65const stream = generateVideo({
66 adapter: openaiVideo('sora-2'),
67 prompt: 'A cat chasing a dog in a sunny park',
68 stream: true,
69 pollingInterval: 3000,
70})
71​
72return toServerSentEventsResponse(stream)
73```