Open History to see the last commit
1---
2id: VideoAdapter
3title: VideoAdapter
4---
5
6# Interface: VideoAdapter\<TModel, TProviderOptions, TModelProviderOptionsByName, TModelSizeByName, TModelInputModalitiesByName, TModelDurationByName\>
7
8Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:60](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L60)
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- TModelProviderOptionsByName: Map from model name to its specific provider options
23- TModelSizeByName: Map from model name to its supported sizes
24- TModelInputModalitiesByName: Map from model name to the non-text prompt
25 modalities it accepts (constrains the `prompt` part types at compile time)
26- TModelDurationByName: Map from model name to its supported duration
27 union. Defaults to `Record<string, number>` so adapters that haven't
28 declared a map keep today's `duration?: number` typing.
29
30## Type Parameters
31
32### TModel
33
34`TModel` *extends* `string` = `string`
35
36### TProviderOptions
37
38`TProviderOptions` *extends* `object` = `Record`\<`string`, `unknown`\>
39
40### TModelProviderOptionsByName
41
42`TModelProviderOptionsByName` *extends* `Record`\<`string`, `any`\> = `Record`\<`string`, `any`\>
43
44### TModelSizeByName
45
46`TModelSizeByName` *extends* `Record`\<`string`, `string` \| `undefined`\> = `Record`\<`string`, `string`\>
47
48### TModelInputModalitiesByName
49
50`TModelInputModalitiesByName` *extends* [`ModelInputModalitiesByName`](../type-aliases/ModelInputModalitiesByName.md) = [`ModelInputModalitiesByName`](../type-aliases/ModelInputModalitiesByName.md)
51
52### TModelDurationByName
53
54`TModelDurationByName` *extends* `Record`\<`string`, `string` \| `number` \| `undefined`\> = `Record`\<`string`, `number`\>
55
56## Properties
57
58### ~types
59
60```ts
61~types: object;
62```
63
64Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:83](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L83)
65
66**`Internal`**
67
68Type-only properties for inference. Not assigned at runtime.
69
70#### modelDurationByName
71
72```ts
73modelDurationByName: TModelDurationByName;
74```
75
76#### modelInputModalitiesByName
77
78```ts
79modelInputModalitiesByName: TModelInputModalitiesByName;
80```
81
82#### modelProviderOptionsByName
83
84```ts
85modelProviderOptionsByName: TModelProviderOptionsByName;
86```
87
88#### modelSizeByName
89
90```ts
91modelSizeByName: TModelSizeByName;
92```
93
94#### providerOptions
95
96```ts
97providerOptions: TProviderOptions;
98```
99
100***
101
102### availableDurations()
103
104```ts
105availableDurations: () => DurationOptions<TModelDurationByName[TModel]>;
106```
107
108Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:119](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L119)
109
110**`Experimental`**
111
112Describe the durations this adapter's model accepts. Returns a tagged
113union so consumers can render UI / coerce input without provider-specific
114knowledge.
115
116#### Returns
117
118`DurationOptions`\<`TModelDurationByName`\[`TModel`\]\>
119
120***
121
122### createVideoJob()
123
124```ts
125createVideoJob: (options) => Promise<VideoJobResult>;
126```
127
128Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:95](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L95)
129
130**`Experimental`**
131
132Create a new video generation job.
133Returns a job ID that can be used to poll for status and retrieve the video.
134
135#### Parameters
136
137##### options
138
139[`VideoGenerationOptions`](VideoGenerationOptions.md)\<`TProviderOptions`, `TModelSizeByName`\[`TModel`\], `TModelDurationByName`\[`TModel`\]\>
140
141#### Returns
142
143`Promise`\<[`VideoJobResult`](VideoJobResult.md)\>
144
145***
146
147### getVideoStatus()
148
149```ts
150getVideoStatus: (jobId) => Promise<VideoStatusResult>;
151```
152
153Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:106](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L106)
154
155**`Experimental`**
156
157Get the current status of a video generation job.
158
159#### Parameters
160
161##### jobId
162
163`string`
164
165#### Returns
166
167`Promise`\<[`VideoStatusResult`](VideoStatusResult.md)\>
168
169***
170
171### getVideoUrl()
172
173```ts
174getVideoUrl: (jobId) => Promise<VideoUrlResult>;
175```
176
177Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:112](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L112)
178
179**`Experimental`**
180
181Get the URL to download/view the generated video.
182Should only be called after status is 'completed'.
183
184#### Parameters
185
186##### jobId
187
188`string`
189
190#### Returns
191
192`Promise`\<[`VideoUrlResult`](VideoUrlResult.md)\>
193
194***
195
196### kind
197
198```ts
199readonly kind: "video";
200```
201
202Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:74](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L74)
203
204**`Experimental`**
205
206Discriminator for adapter kind - used to determine API shape
207
208***
209
210### model
211
212```ts
213readonly model: TModel;
214```
215
216Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:78](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L78)
217
218**`Experimental`**
219
220The model this adapter is configured for
221
222***
223
224### name
225
226```ts
227readonly name: string;
228```
229
230Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:76](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L76)
231
232**`Experimental`**
233
234Adapter name identifier
235
236***
237
238### snapDuration()
239
240```ts
241snapDuration: (seconds) => TModelDurationByName[TModel] | undefined;
242```
243
244Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:125](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L125)
245
246**`Experimental`**
247
248Coerce a raw seconds value to the closest valid duration for this model.
249Returns `undefined` for models with no duration field.
250
251#### Parameters
252
253##### seconds
254
255`number`
256
257#### Returns
258
259`TModelDurationByName`\[`TModel`\] \| `undefined`