Open History to see the last commit
1---
2id: VideoAdapter
3title: VideoAdapter
4---
5
6# Interface: VideoAdapter\<TModel, TProviderOptions\>
7
8Defined in: [activities/generateVideo/adapter.ts:33](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/adapter.ts#L33)
9
10**`Experimental`**
11
12Video adapter interface with pre-resolved generics.
13
14An adapter is created by a provider function: `provider('model')` → `adapter`
15All type resolution happens at the provider call site, not in this interface.
16
17 Video generation is an experimental feature and may change.
18
19Generic parameters:
20- TModel: The specific model name (e.g., 'sora-2')
21- TProviderOptions: Provider-specific options (already resolved)
22
23## Type Parameters
24
25### TModel
26
27`TModel` *extends* `string` = `string`
28
29### TProviderOptions
30
31`TProviderOptions` *extends* `object` = `Record`\<`string`, `unknown`\>
32
33## Properties
34
35### ~types
36
37```ts
38~types: object;
39```
40
41Defined in: [activities/generateVideo/adapter.ts:47](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/adapter.ts#L47)
42
43**`Internal`**
44
45Type-only properties for inference. Not assigned at runtime.
46
47#### providerOptions
48
49```ts
50providerOptions: TProviderOptions;
51```
52
53***
54
55### createVideoJob()
56
57```ts
58createVideoJob: (options) => Promise<VideoJobResult>;
59```
60
61Defined in: [activities/generateVideo/adapter.ts:55](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/adapter.ts#L55)
62
63**`Experimental`**
64
65Create a new video generation job.
66Returns a job ID that can be used to poll for status and retrieve the video.
67
68#### Parameters
69
70##### options
71
72[`VideoGenerationOptions`](VideoGenerationOptions.md)\<`TProviderOptions`\>
73
74#### Returns
75
76`Promise`\<[`VideoJobResult`](VideoJobResult.md)\>
77
78***
79
80### getVideoStatus()
81
82```ts
83getVideoStatus: (jobId) => Promise<VideoStatusResult>;
84```
85
86Defined in: [activities/generateVideo/adapter.ts:62](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/adapter.ts#L62)
87
88**`Experimental`**
89
90Get the current status of a video generation job.
91
92#### Parameters
93
94##### jobId
95
96`string`
97
98#### Returns
99
100`Promise`\<[`VideoStatusResult`](VideoStatusResult.md)\>
101
102***
103
104### getVideoUrl()
105
106```ts
107getVideoUrl: (jobId) => Promise<VideoUrlResult>;
108```
109
110Defined in: [activities/generateVideo/adapter.ts:68](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/adapter.ts#L68)
111
112**`Experimental`**
113
114Get the URL to download/view the generated video.
115Should only be called after status is 'completed'.
116
117#### Parameters
118
119##### jobId
120
121`string`
122
123#### Returns
124
125`Promise`\<[`VideoUrlResult`](VideoUrlResult.md)\>
126
127***
128
129### kind
130
131```ts
132readonly kind: "video";
133```
134
135Defined in: [activities/generateVideo/adapter.ts:38](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/adapter.ts#L38)
136
137**`Experimental`**
138
139Discriminator for adapter kind - used to determine API shape
140
141***
142
143### model
144
145```ts
146readonly model: TModel;
147```
148
149Defined in: [activities/generateVideo/adapter.ts:42](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/adapter.ts#L42)
150
151**`Experimental`**
152
153The model this adapter is configured for
154
155***
156
157### name
158
159```ts
160readonly name: string;
161```
162
163Defined in: [activities/generateVideo/adapter.ts:40](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/adapter.ts#L40)
164
165**`Experimental`**
166
167Adapter name identifier