@shotstack/schemas 1.13.3 → 1.14.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -348,6 +348,75 @@
348
348
  }
349
349
  ]
350
350
  },
351
+ "resolution": {
352
+ "anyOf": [
353
+ {
354
+ "type": "string",
355
+ "enum": [
356
+ "480p",
357
+ "720p",
358
+ "1080p"
359
+ ]
360
+ },
361
+ {
362
+ "type": "null"
363
+ }
364
+ ]
365
+ },
366
+ "duration": {
367
+ "anyOf": [
368
+ {
369
+ "type": "string",
370
+ "enum": [
371
+ "auto",
372
+ "4",
373
+ "5",
374
+ "6",
375
+ "7",
376
+ "8",
377
+ "9",
378
+ "10",
379
+ "11",
380
+ "12",
381
+ "13",
382
+ "14",
383
+ "15"
384
+ ]
385
+ },
386
+ {
387
+ "type": "null"
388
+ }
389
+ ]
390
+ },
391
+ "aspectRatio": {
392
+ "anyOf": [
393
+ {
394
+ "type": "string",
395
+ "enum": [
396
+ "1:1",
397
+ "16:9",
398
+ "9:16",
399
+ "4:3",
400
+ "3:4",
401
+ "21:9",
402
+ "9:21"
403
+ ]
404
+ },
405
+ {
406
+ "type": "null"
407
+ }
408
+ ]
409
+ },
410
+ "generateAudio": {
411
+ "anyOf": [
412
+ {
413
+ "type": "boolean"
414
+ },
415
+ {
416
+ "type": "null"
417
+ }
418
+ ]
419
+ },
351
420
  "transcode": {
352
421
  "anyOf": [
353
422
  {
@@ -442,6 +511,10 @@
442
511
  "prompt",
443
512
  "inputSrc",
444
513
  "model",
514
+ "resolution",
515
+ "duration",
516
+ "aspectRatio",
517
+ "generateAudio",
445
518
  "transcode",
446
519
  "trim",
447
520
  "volume",
@@ -697,6 +770,40 @@
697
770
  }
698
771
  ]
699
772
  },
773
+ "resolution": {
774
+ "anyOf": [
775
+ {
776
+ "type": "string",
777
+ "enum": [
778
+ "1K",
779
+ "2K",
780
+ "4K"
781
+ ]
782
+ },
783
+ {
784
+ "type": "null"
785
+ }
786
+ ]
787
+ },
788
+ "aspectRatio": {
789
+ "anyOf": [
790
+ {
791
+ "type": "string",
792
+ "enum": [
793
+ "1:1",
794
+ "16:9",
795
+ "9:16",
796
+ "4:3",
797
+ "3:4",
798
+ "21:9",
799
+ "9:21"
800
+ ]
801
+ },
802
+ {
803
+ "type": "null"
804
+ }
805
+ ]
806
+ },
700
807
  "crop": {
701
808
  "anyOf": [
702
809
  {
@@ -714,6 +821,8 @@
714
821
  "src",
715
822
  "prompt",
716
823
  "model",
824
+ "resolution",
825
+ "aspectRatio",
717
826
  "crop"
718
827
  ]
719
828
  },
@@ -1541,6 +1650,38 @@
1541
1650
  }
1542
1651
  ]
1543
1652
  },
1653
+ "musicLengthMs": {
1654
+ "anyOf": [
1655
+ {
1656
+ "type": "number",
1657
+ "minimum": 3000,
1658
+ "maximum": 600000
1659
+ },
1660
+ {
1661
+ "type": "null"
1662
+ }
1663
+ ]
1664
+ },
1665
+ "forceInstrumental": {
1666
+ "anyOf": [
1667
+ {
1668
+ "type": "boolean"
1669
+ },
1670
+ {
1671
+ "type": "null"
1672
+ }
1673
+ ]
1674
+ },
1675
+ "compositionPlan": {
1676
+ "anyOf": [
1677
+ {
1678
+ "type": "string"
1679
+ },
1680
+ {
1681
+ "type": "null"
1682
+ }
1683
+ ]
1684
+ },
1544
1685
  "trim": {
1545
1686
  "anyOf": [
1546
1687
  {
@@ -1607,6 +1748,9 @@
1607
1748
  "language",
1608
1749
  "newscaster",
1609
1750
  "model",
1751
+ "musicLengthMs",
1752
+ "forceInstrumental",
1753
+ "compositionPlan",
1610
1754
  "trim",
1611
1755
  "volume",
1612
1756
  "speed",
@@ -2,21 +2,21 @@
2
2
  "name": "VideoAsset",
3
3
  "strict": true,
4
4
  "schema": {
5
- "description": "The VideoAsset adds a video to a Clip. The video can be sourced from a URL\n(`src`) or generated from a text prompt (`prompt`), optionally from a\nstarting image (`inputSrc`). Exactly one of `s...",
5
+ "description": "The VideoAsset adds a video to a Clip. The video can be sourced from a URL\n(`src`) or generated from a text prompt (`prom...",
6
6
  "type": "object",
7
7
  "properties": {
8
8
  "type": {
9
9
  "enum": [
10
10
  "video"
11
11
  ],
12
- "description": "The type of a...",
12
+ "description": "The typ...",
13
13
  "type": "string"
14
14
  },
15
15
  "src": {
16
16
  "anyOf": [
17
17
  {
18
18
  "type": "string",
19
- "description": "The video source URL. The URL must be pu..."
19
+ "description": "The video source URL. The..."
20
20
  },
21
21
  {
22
22
  "type": "null"
@@ -27,7 +27,7 @@
27
27
  "anyOf": [
28
28
  {
29
29
  "type": "string",
30
- "description": "A text prompt to generate the video from. When set without `src`, the e..."
30
+ "description": "A text prompt to generate the video from. Whe..."
31
31
  },
32
32
  {
33
33
  "type": "null"
@@ -38,7 +38,7 @@
38
38
  "anyOf": [
39
39
  {
40
40
  "type": "string",
41
- "description": "Input image URL for image-to-video generation. The ..."
41
+ "description": "Input image URL for image-to-vid..."
42
42
  },
43
43
  {
44
44
  "type": "null"
@@ -49,7 +49,80 @@
49
49
  "anyOf": [
50
50
  {
51
51
  "type": "string",
52
- "description": "The generation model to use when `prompt` is set..."
52
+ "description": "The generation model to use when `..."
53
+ },
54
+ {
55
+ "type": "null"
56
+ }
57
+ ]
58
+ },
59
+ "resolution": {
60
+ "anyOf": [
61
+ {
62
+ "type": "string",
63
+ "description": "Output resolution for vid...",
64
+ "enum": [
65
+ "480p",
66
+ "720p",
67
+ "1080p"
68
+ ]
69
+ },
70
+ {
71
+ "type": "null"
72
+ }
73
+ ]
74
+ },
75
+ "duration": {
76
+ "anyOf": [
77
+ {
78
+ "type": "string",
79
+ "description": "Target video duration in sec...",
80
+ "enum": [
81
+ "auto",
82
+ "4",
83
+ "5",
84
+ "6",
85
+ "7",
86
+ "8",
87
+ "9",
88
+ "10",
89
+ "11",
90
+ "12",
91
+ "13",
92
+ "14",
93
+ "15"
94
+ ]
95
+ },
96
+ {
97
+ "type": "null"
98
+ }
99
+ ]
100
+ },
101
+ "aspectRatio": {
102
+ "anyOf": [
103
+ {
104
+ "type": "string",
105
+ "description": "Aspect ratio for th...",
106
+ "enum": [
107
+ "1:1",
108
+ "16:9",
109
+ "9:16",
110
+ "4:3",
111
+ "3:4",
112
+ "21:9",
113
+ "9:21"
114
+ ]
115
+ },
116
+ {
117
+ "type": "null"
118
+ }
119
+ ]
120
+ },
121
+ "generateAudio": {
122
+ "anyOf": [
123
+ {
124
+ "type": "boolean",
125
+ "description": "Set to `true` to request audio..."
53
126
  },
54
127
  {
55
128
  "type": "null"
@@ -60,7 +133,7 @@
60
133
  "anyOf": [
61
134
  {
62
135
  "type": "boolean",
63
- "description": "Set to `true` to force re-encoding of the video during preprocessing. This can help reso..."
136
+ "description": "Set to `true` to force re-encoding of the video during ..."
64
137
  },
65
138
  {
66
139
  "type": "null"
@@ -71,7 +144,7 @@
71
144
  "anyOf": [
72
145
  {
73
146
  "type": "number",
74
- "description": "The start trim point of the video clip, in seconds (default..."
147
+ "description": "The start trim point of the video cli..."
75
148
  },
76
149
  {
77
150
  "type": "null"
@@ -79,17 +152,17 @@
79
152
  ]
80
153
  },
81
154
  "volume": {
82
- "description": "Set the volume of the video clip. Use a nu...",
155
+ "description": "Set the volume of the vid...",
83
156
  "anyOf": [
84
157
  {
85
158
  "type": "number",
86
- "description": "The volume level for the video clip. ...",
159
+ "description": "The volume level for th...",
87
160
  "minimum": 0,
88
161
  "maximum": 1
89
162
  },
90
163
  {
91
164
  "type": "array",
92
- "description": "An array of [Tween](./#tocs_tween) obje...",
165
+ "description": "An array of [Tween](./#t...",
93
166
  "items": {
94
167
  "$ref": "#/$defs/Tween"
95
168
  }
@@ -103,7 +176,7 @@
103
176
  "anyOf": [
104
177
  {
105
178
  "type": "string",
106
- "description": "Preset volume effects to apply to the video asset <ul>\n <li>`fade...",
179
+ "description": "Preset volume effects to apply to the vid...",
107
180
  "enum": [
108
181
  "none",
109
182
  "fadeIn",
@@ -120,7 +193,7 @@
120
193
  "anyOf": [
121
194
  {
122
195
  "type": "number",
123
- "description": "Adjust the playback speed of the video clip between 0 (paused) and 10 (10x normal speed) where 1 is normal speed (defaults to 1). Adjusting the speed will also adjus...",
196
+ "description": "Adjust the playback speed of the video clip between 0 (paused) and 10 (10x normal speed) where 1 is norma...",
124
197
  "minimum": 0,
125
198
  "maximum": 10
126
199
  },
@@ -157,6 +230,10 @@
157
230
  "prompt",
158
231
  "inputSrc",
159
232
  "model",
233
+ "resolution",
234
+ "duration",
235
+ "aspectRatio",
236
+ "generateAudio",
160
237
  "transcode",
161
238
  "trim",
162
239
  "volume",
@@ -167,13 +244,13 @@
167
244
  ],
168
245
  "$defs": {
169
246
  "Tween": {
170
- "description": "Use a Tween to [animate properties over time](/docs/guide/architecting-an-application/animations/). The following properties are currently supported and can be animated:...",
247
+ "description": "Use a Tween to [animate properties over time](/docs/guide/architecting-an-application/animations/). The fol...",
171
248
  "properties": {
172
249
  "from": {
173
250
  "anyOf": [
174
251
  {
175
252
  "type": "string",
176
- "description": "The initial prop..."
253
+ "description": "The initi..."
177
254
  },
178
255
  {
179
256
  "type": "null"
@@ -184,7 +261,7 @@
184
261
  "anyOf": [
185
262
  {
186
263
  "type": "string",
187
- "description": "The final prope..."
264
+ "description": "The fina..."
188
265
  },
189
266
  {
190
267
  "type": "null"
@@ -195,7 +272,7 @@
195
272
  "anyOf": [
196
273
  {
197
274
  "type": "number",
198
- "description": "The time in seconds when th..."
275
+ "description": "The time in seco..."
199
276
  },
200
277
  {
201
278
  "type": "null"
@@ -206,7 +283,7 @@
206
283
  "anyOf": [
207
284
  {
208
285
  "type": "number",
209
- "description": "The duratio..."
286
+ "description": "The du..."
210
287
  },
211
288
  {
212
289
  "type": "null"
@@ -217,7 +294,7 @@
217
294
  "anyOf": [
218
295
  {
219
296
  "type": "string",
220
- "description": "The interpolation method to use for the animation. Available options are: <ul>\n <li>`linear` - a linear interpolation between the s...",
297
+ "description": "The interpolation method to use for the animation. Available options are: <ul>\n <li...",
221
298
  "enum": [
222
299
  "linear",
223
300
  "bezier",
@@ -233,7 +310,7 @@
233
310
  "anyOf": [
234
311
  {
235
312
  "type": "string",
236
- "description": "The easing function to use for the animation. Easing controls the rate of change of th...",
313
+ "description": "The easing function to use for the animation. Easing c...",
237
314
  "enum": [
238
315
  "ease",
239
316
  "easeIn",
@@ -283,13 +360,13 @@
283
360
  ]
284
361
  },
285
362
  "Crop": {
286
- "description": "Crop the sides of an asset by a relative amount. The size of the crop is specified using a s...",
363
+ "description": "Crop the sides of an asset by a relative amount. The size ...",
287
364
  "properties": {
288
365
  "top": {
289
366
  "anyOf": [
290
367
  {
291
368
  "type": "number",
292
- "description": "Crop fr...",
369
+ "description": "Cro...",
293
370
  "minimum": 0,
294
371
  "maximum": 1
295
372
  },
@@ -302,7 +379,7 @@
302
379
  "anyOf": [
303
380
  {
304
381
  "type": "number",
305
- "description": "Crop fro...",
382
+ "description": "Crop...",
306
383
  "minimum": 0,
307
384
  "maximum": 1
308
385
  },
@@ -315,7 +392,7 @@
315
392
  "anyOf": [
316
393
  {
317
394
  "type": "number",
318
- "description": "Crop fr...",
395
+ "description": "Cro...",
319
396
  "minimum": 0,
320
397
  "maximum": 1
321
398
  },
@@ -328,7 +405,7 @@
328
405
  "anyOf": [
329
406
  {
330
407
  "type": "number",
331
- "description": "Crop fr...",
408
+ "description": "Cro...",
332
409
  "minimum": 0,
333
410
  "maximum": 1
334
411
  },
@@ -348,17 +425,17 @@
348
425
  ]
349
426
  },
350
427
  "ChromaKey": {
351
- "description": "Chroma key is a technique that replaces a specific color in a video with a...",
428
+ "description": "Chroma key is a technique that replaces a spec...",
352
429
  "properties": {
353
430
  "color": {
354
- "description": "The chroma key color as a hex value. Use green (#00b...",
431
+ "description": "The chroma key color as a hex va...",
355
432
  "type": "string"
356
433
  },
357
434
  "threshold": {
358
435
  "anyOf": [
359
436
  {
360
437
  "type": "integer",
361
- "description": "Pixels within this distance fro...",
438
+ "description": "Pixels within this ...",
362
439
  "minimum": 0,
363
440
  "maximum": 250
364
441
  },
@@ -371,7 +448,7 @@
371
448
  "anyOf": [
372
449
  {
373
450
  "type": "integer",
374
- "description": "Pixels within the halo distance from the thre...",
451
+ "description": "Pixels within the halo dista...",
375
452
  "minimum": 0,
376
453
  "maximum": 250
377
454
  },
package/dist/schema.d.ts CHANGED
@@ -583,10 +583,34 @@ export interface components {
583
583
  */
584
584
  inputSrc?: string;
585
585
  /**
586
- * @description The generation model to use when `prompt` is set (e.g. `luma-ray-3`, `runpod-itv-mini`). Defaults to the platform's preferred generator if omitted.
586
+ * @description The generation model to use when `prompt` is set (e.g. `luma-ray-3`, `runpod-itv-mini`, `fal/seedance-2.0`). Defaults to the platform's preferred generator if omitted.
587
587
  * @example luma-ray-3
588
588
  */
589
589
  model?: string;
590
+ /**
591
+ * @description Output resolution for video generation. Only meaningful when `prompt` is set and the model supports it (e.g. `fal/seedance-2.0`).
592
+ * @example 720p
593
+ * @enum {string}
594
+ */
595
+ resolution?: "480p" | "720p" | "1080p";
596
+ /**
597
+ * @description Target video duration in seconds for generation models that accept it. `"auto"` lets the model decide. Only meaningful when `prompt` is set.
598
+ * @default auto
599
+ * @example 5
600
+ * @enum {string}
601
+ */
602
+ duration?: "auto" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12" | "13" | "14" | "15";
603
+ /**
604
+ * @description Aspect ratio for the generated video. Only meaningful when `prompt` is set and the model supports it.
605
+ * @example 16:9
606
+ * @enum {string}
607
+ */
608
+ aspectRatio?: "1:1" | "16:9" | "9:16" | "4:3" | "3:4" | "21:9" | "9:21";
609
+ /**
610
+ * @description Set to `true` to request audio generation alongside the video. Only meaningful for video generation models that support it (e.g. `fal/seedance-2.0`).
611
+ * @default false
612
+ */
613
+ generateAudio?: boolean;
590
614
  /**
591
615
  * @description Set to `true` to force re-encoding of the video during preprocessing. This can help resolve compatibility issues, fix rotation problems, synchronize audio, or convert formats. The video will be processed to ensure optimal compatibility with the rendering engine.
592
616
  * @example false
@@ -643,10 +667,22 @@ export interface components {
643
667
  */
644
668
  prompt?: string;
645
669
  /**
646
- * @description The generation model to use when `prompt` is set (e.g. `flux-schnell`). Defaults to the platform's preferred generator if omitted.
670
+ * @description The generation model to use when `prompt` is set (e.g. `flux-schnell`, `fal/flux-schnell`, `fal/nano-banana-2`). Defaults to the platform's preferred generator if omitted.
647
671
  * @example flux-schnell
648
672
  */
649
673
  model?: string;
674
+ /**
675
+ * @description Output resolution tier for supported image generation models. `1K` (default), `2K`, or `4K`. Only meaningful when `prompt` is set.
676
+ * @example 1K
677
+ * @enum {string}
678
+ */
679
+ resolution?: "1K" | "2K" | "4K";
680
+ /**
681
+ * @description Aspect ratio for the generated image. Only meaningful when `prompt` is set and the model supports it.
682
+ * @example 1:1
683
+ * @enum {string}
684
+ */
685
+ aspectRatio?: "1:1" | "16:9" | "9:16" | "4:3" | "3:4" | "21:9" | "9:21";
650
686
  crop?: components["schemas"]["Crop"];
651
687
  };
652
688
  /**
@@ -843,10 +879,22 @@ export interface components {
843
879
  */
844
880
  newscaster?: boolean;
845
881
  /**
846
- * @description The generation model to use when `prompt` is set (e.g. `polly-neural`). Defaults to the platform's preferred generator if omitted.
882
+ * @description The generation model to use when `prompt` is set (e.g. `polly-neural`, `fal/elevenlabs-tts`, `fal/minimax-speech`, `fal/elevenlabs-music`). Defaults to the platform's preferred generator if omitted.
847
883
  * @example polly-neural
848
884
  */
849
885
  model?: string;
886
+ /**
887
+ * @description Target duration in milliseconds for generated music (3,000–600,000). Only meaningful when `prompt` is set and the model is a music generator (e.g. `fal/elevenlabs-music`).
888
+ * @example 30000
889
+ */
890
+ musicLengthMs?: number;
891
+ /**
892
+ * @description Set to `true` to force instrumental music (no vocals). Only meaningful for music generation models.
893
+ * @default false
894
+ */
895
+ forceInstrumental?: boolean;
896
+ /** @description An optional structured composition plan for music generation. Only meaningful for music generation models (e.g. `fal/elevenlabs-music`). */
897
+ compositionPlan?: string;
850
898
  /** @description The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the in trim point. The audio will play until the file ends or the Clip length is reached. */
851
899
  trim?: number;
852
900
  /** @description Set the volume of the audio clip. Use a number or an array of [Tween](./#tocs_tween) objects to create custom volume transitions. */
@@ -2479,16 +2527,16 @@ export interface components {
2479
2527
  * @example google-drive
2480
2528
  */
2481
2529
  provider: string;
2482
- /** @description Additional Google Drive configuration and features. */
2483
- options: components["schemas"]["GoogleDriveDestinationOptions"];
2530
+ /** @description Additional Google Drive configuration and features. If omitted, files are saved to the root of My Drive using the default Shotstack filename. */
2531
+ options?: components["schemas"]["GoogleDriveDestinationOptions"];
2484
2532
  };
2485
2533
  /** @description Pass the folder ID and options to configure how assets are stored in Google Drive. */
2486
2534
  GoogleDriveDestinationOptions: {
2487
2535
  /**
2488
- * @description The Google Drive folder ID where asset will be stored. The folder ID is required and can be retrieved from the URL when logged in to Google Drive, e.g. <a href="#">https://drive.google.com/drive/u/0/folders/1r-eTY6OLO8tzQRKwMyq-fIrQ_7AJEI6A</a>.
2536
+ * @description The Google Drive folder ID where the asset will be stored. If omitted, the asset is saved to the root of My Drive. The folder ID can be retrieved from the URL when logged in to Google Drive, e.g. <a href="#">https://drive.google.com/drive/u/0/folders/1r-eTY6OLO8tzQRKwMyq-fIrQ_7AJEI6A</a>.
2489
2537
  * @example 1r-eTY6OLO8tzQRKwMyq-fIrQ_7AJEI6A
2490
2538
  */
2491
- folderId: string;
2539
+ folderId?: string;
2492
2540
  /**
2493
2541
  * @description Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images.
2494
2542
  * @example my-file