@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.
@@ -497,7 +497,80 @@
497
497
  "anyOf": [
498
498
  {
499
499
  "type": "string",
500
- "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."
500
+ "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."
501
+ },
502
+ {
503
+ "type": "null"
504
+ }
505
+ ]
506
+ },
507
+ "resolution": {
508
+ "anyOf": [
509
+ {
510
+ "type": "string",
511
+ "description": "Output resolution for video generation. Only meaningful when `prompt` is set and the model supports it (e.g. `fal/seedance-2.0`).",
512
+ "enum": [
513
+ "480p",
514
+ "720p",
515
+ "1080p"
516
+ ]
517
+ },
518
+ {
519
+ "type": "null"
520
+ }
521
+ ]
522
+ },
523
+ "duration": {
524
+ "anyOf": [
525
+ {
526
+ "type": "string",
527
+ "description": "Target video duration in seconds for generation models that accept it. `\"auto\"` lets the model decide. Only meaningful when `prompt` is set.",
528
+ "enum": [
529
+ "auto",
530
+ "4",
531
+ "5",
532
+ "6",
533
+ "7",
534
+ "8",
535
+ "9",
536
+ "10",
537
+ "11",
538
+ "12",
539
+ "13",
540
+ "14",
541
+ "15"
542
+ ]
543
+ },
544
+ {
545
+ "type": "null"
546
+ }
547
+ ]
548
+ },
549
+ "aspectRatio": {
550
+ "anyOf": [
551
+ {
552
+ "type": "string",
553
+ "description": "Aspect ratio for the generated video. Only meaningful when `prompt` is set and the model supports it.",
554
+ "enum": [
555
+ "1:1",
556
+ "16:9",
557
+ "9:16",
558
+ "4:3",
559
+ "3:4",
560
+ "21:9",
561
+ "9:21"
562
+ ]
563
+ },
564
+ {
565
+ "type": "null"
566
+ }
567
+ ]
568
+ },
569
+ "generateAudio": {
570
+ "anyOf": [
571
+ {
572
+ "type": "boolean",
573
+ "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`)."
501
574
  },
502
575
  {
503
576
  "type": "null"
@@ -605,6 +678,10 @@
605
678
  "prompt",
606
679
  "inputSrc",
607
680
  "model",
681
+ "resolution",
682
+ "duration",
683
+ "aspectRatio",
684
+ "generateAudio",
608
685
  "transcode",
609
686
  "trim",
610
687
  "volume",
@@ -874,7 +951,43 @@
874
951
  "anyOf": [
875
952
  {
876
953
  "type": "string",
877
- "description": "The generation model to use when `prompt` is set (e.g. `flux-schnell`). Defaults to the platform's preferred generator if omitted."
954
+ "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."
955
+ },
956
+ {
957
+ "type": "null"
958
+ }
959
+ ]
960
+ },
961
+ "resolution": {
962
+ "anyOf": [
963
+ {
964
+ "type": "string",
965
+ "description": "Output resolution tier for supported image generation models. `1K` (default), `2K`, or `4K`. Only meaningful when `prompt` is set.",
966
+ "enum": [
967
+ "1K",
968
+ "2K",
969
+ "4K"
970
+ ]
971
+ },
972
+ {
973
+ "type": "null"
974
+ }
975
+ ]
976
+ },
977
+ "aspectRatio": {
978
+ "anyOf": [
979
+ {
980
+ "type": "string",
981
+ "description": "Aspect ratio for the generated image. Only meaningful when `prompt` is set and the model supports it.",
982
+ "enum": [
983
+ "1:1",
984
+ "16:9",
985
+ "9:16",
986
+ "4:3",
987
+ "3:4",
988
+ "21:9",
989
+ "9:21"
990
+ ]
878
991
  },
879
992
  {
880
993
  "type": "null"
@@ -898,6 +1011,8 @@
898
1011
  "src",
899
1012
  "prompt",
900
1013
  "model",
1014
+ "resolution",
1015
+ "aspectRatio",
901
1016
  "crop"
902
1017
  ]
903
1018
  },
@@ -1793,7 +1908,42 @@
1793
1908
  "anyOf": [
1794
1909
  {
1795
1910
  "type": "string",
1796
- "description": "The generation model to use when `prompt` is set (e.g. `polly-neural`). Defaults to the platform's preferred generator if omitted."
1911
+ "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."
1912
+ },
1913
+ {
1914
+ "type": "null"
1915
+ }
1916
+ ]
1917
+ },
1918
+ "musicLengthMs": {
1919
+ "anyOf": [
1920
+ {
1921
+ "type": "number",
1922
+ "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`).",
1923
+ "minimum": 3000,
1924
+ "maximum": 600000
1925
+ },
1926
+ {
1927
+ "type": "null"
1928
+ }
1929
+ ]
1930
+ },
1931
+ "forceInstrumental": {
1932
+ "anyOf": [
1933
+ {
1934
+ "type": "boolean",
1935
+ "description": "Set to `true` to force instrumental music (no vocals). Only meaningful for music generation models."
1936
+ },
1937
+ {
1938
+ "type": "null"
1939
+ }
1940
+ ]
1941
+ },
1942
+ "compositionPlan": {
1943
+ "anyOf": [
1944
+ {
1945
+ "type": "string",
1946
+ "description": "An optional structured composition plan for music generation. Only meaningful for music generation models (e.g. `fal/elevenlabs-music`)."
1797
1947
  },
1798
1948
  {
1799
1949
  "type": "null"
@@ -1872,6 +2022,9 @@
1872
2022
  "language",
1873
2023
  "newscaster",
1874
2024
  "model",
2025
+ "musicLengthMs",
2026
+ "forceInstrumental",
2027
+ "compositionPlan",
1875
2028
  "trim",
1876
2029
  "volume",
1877
2030
  "speed",
@@ -4271,8 +4424,15 @@
4271
4424
  ]
4272
4425
  },
4273
4426
  "options": {
4274
- "description": "Additional Google Drive configuration and features.",
4275
- "$ref": "#/$defs/GoogleDriveDestinationOptions"
4427
+ "anyOf": [
4428
+ {
4429
+ "description": "Additional Google Drive configuration and features. If omitted, files are saved to the root of My Drive using the default Shotstack filename.",
4430
+ "$ref": "#/$defs/GoogleDriveDestinationOptions"
4431
+ },
4432
+ {
4433
+ "type": "null"
4434
+ }
4435
+ ]
4276
4436
  }
4277
4437
  },
4278
4438
  "type": "object",
@@ -4286,8 +4446,15 @@
4286
4446
  "description": "Pass the folder ID and options to configure how assets are stored in Google Drive.",
4287
4447
  "properties": {
4288
4448
  "folderId": {
4289
- "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>.",
4290
- "type": "string"
4449
+ "anyOf": [
4450
+ {
4451
+ "type": "string",
4452
+ "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>."
4453
+ },
4454
+ {
4455
+ "type": "null"
4456
+ }
4457
+ ]
4291
4458
  },
4292
4459
  "filename": {
4293
4460
  "anyOf": [
@@ -4301,12 +4468,12 @@
4301
4468
  ]
4302
4469
  }
4303
4470
  },
4471
+ "type": "object",
4472
+ "additionalProperties": false,
4304
4473
  "required": [
4305
4474
  "folderId",
4306
4475
  "filename"
4307
- ],
4308
- "type": "object",
4309
- "additionalProperties": false
4476
+ ]
4310
4477
  },
4311
4478
  "VimeoDestination": {
4312
4479
  "description": "Send videos to [Vimeo](https://shotstack.io/docs/guide/serving-assets/destinations/vimeo/) video hosting and streaming service. Vimeo credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/vimeo), not in the request.",
@@ -251,6 +251,75 @@
251
251
  }
252
252
  ]
253
253
  },
254
+ "resolution": {
255
+ "anyOf": [
256
+ {
257
+ "type": "string",
258
+ "enum": [
259
+ "480p",
260
+ "720p",
261
+ "1080p"
262
+ ]
263
+ },
264
+ {
265
+ "type": "null"
266
+ }
267
+ ]
268
+ },
269
+ "duration": {
270
+ "anyOf": [
271
+ {
272
+ "type": "string",
273
+ "enum": [
274
+ "auto",
275
+ "4",
276
+ "5",
277
+ "6",
278
+ "7",
279
+ "8",
280
+ "9",
281
+ "10",
282
+ "11",
283
+ "12",
284
+ "13",
285
+ "14",
286
+ "15"
287
+ ]
288
+ },
289
+ {
290
+ "type": "null"
291
+ }
292
+ ]
293
+ },
294
+ "aspectRatio": {
295
+ "anyOf": [
296
+ {
297
+ "type": "string",
298
+ "enum": [
299
+ "1:1",
300
+ "16:9",
301
+ "9:16",
302
+ "4:3",
303
+ "3:4",
304
+ "21:9",
305
+ "9:21"
306
+ ]
307
+ },
308
+ {
309
+ "type": "null"
310
+ }
311
+ ]
312
+ },
313
+ "generateAudio": {
314
+ "anyOf": [
315
+ {
316
+ "type": "boolean"
317
+ },
318
+ {
319
+ "type": "null"
320
+ }
321
+ ]
322
+ },
254
323
  "trim": {
255
324
  "anyOf": [
256
325
  {
@@ -309,6 +378,10 @@
309
378
  "prompt",
310
379
  "inputSrc",
311
380
  "model",
381
+ "resolution",
382
+ "duration",
383
+ "aspectRatio",
384
+ "generateAudio",
312
385
  "trim",
313
386
  "volume",
314
387
  "volumeEffect",
@@ -353,6 +426,40 @@
353
426
  "type": "null"
354
427
  }
355
428
  ]
429
+ },
430
+ "resolution": {
431
+ "anyOf": [
432
+ {
433
+ "type": "string",
434
+ "enum": [
435
+ "1K",
436
+ "2K",
437
+ "4K"
438
+ ]
439
+ },
440
+ {
441
+ "type": "null"
442
+ }
443
+ ]
444
+ },
445
+ "aspectRatio": {
446
+ "anyOf": [
447
+ {
448
+ "type": "string",
449
+ "enum": [
450
+ "1:1",
451
+ "16:9",
452
+ "9:16",
453
+ "4:3",
454
+ "3:4",
455
+ "21:9",
456
+ "9:21"
457
+ ]
458
+ },
459
+ {
460
+ "type": "null"
461
+ }
462
+ ]
356
463
  }
357
464
  },
358
465
  "additionalProperties": false,
@@ -360,7 +467,9 @@
360
467
  "type",
361
468
  "src",
362
469
  "prompt",
363
- "model"
470
+ "model",
471
+ "resolution",
472
+ "aspectRatio"
364
473
  ]
365
474
  },
366
475
  "AudioAsset": {
@@ -432,6 +541,38 @@
432
541
  }
433
542
  ]
434
543
  },
544
+ "musicLengthMs": {
545
+ "anyOf": [
546
+ {
547
+ "type": "number",
548
+ "minimum": 3000,
549
+ "maximum": 600000
550
+ },
551
+ {
552
+ "type": "null"
553
+ }
554
+ ]
555
+ },
556
+ "forceInstrumental": {
557
+ "anyOf": [
558
+ {
559
+ "type": "boolean"
560
+ },
561
+ {
562
+ "type": "null"
563
+ }
564
+ ]
565
+ },
566
+ "compositionPlan": {
567
+ "anyOf": [
568
+ {
569
+ "type": "string"
570
+ },
571
+ {
572
+ "type": "null"
573
+ }
574
+ ]
575
+ },
435
576
  "trim": {
436
577
  "anyOf": [
437
578
  {
@@ -480,6 +621,9 @@
480
621
  "language",
481
622
  "newscaster",
482
623
  "model",
624
+ "musicLengthMs",
625
+ "forceInstrumental",
626
+ "compositionPlan",
483
627
  "trim",
484
628
  "volume",
485
629
  "effect"
@@ -461,6 +461,75 @@
461
461
  }
462
462
  ]
463
463
  },
464
+ "resolution": {
465
+ "anyOf": [
466
+ {
467
+ "type": "string",
468
+ "enum": [
469
+ "480p",
470
+ "720p",
471
+ "1080p"
472
+ ]
473
+ },
474
+ {
475
+ "type": "null"
476
+ }
477
+ ]
478
+ },
479
+ "duration": {
480
+ "anyOf": [
481
+ {
482
+ "type": "string",
483
+ "enum": [
484
+ "auto",
485
+ "4",
486
+ "5",
487
+ "6",
488
+ "7",
489
+ "8",
490
+ "9",
491
+ "10",
492
+ "11",
493
+ "12",
494
+ "13",
495
+ "14",
496
+ "15"
497
+ ]
498
+ },
499
+ {
500
+ "type": "null"
501
+ }
502
+ ]
503
+ },
504
+ "aspectRatio": {
505
+ "anyOf": [
506
+ {
507
+ "type": "string",
508
+ "enum": [
509
+ "1:1",
510
+ "16:9",
511
+ "9:16",
512
+ "4:3",
513
+ "3:4",
514
+ "21:9",
515
+ "9:21"
516
+ ]
517
+ },
518
+ {
519
+ "type": "null"
520
+ }
521
+ ]
522
+ },
523
+ "generateAudio": {
524
+ "anyOf": [
525
+ {
526
+ "type": "boolean"
527
+ },
528
+ {
529
+ "type": "null"
530
+ }
531
+ ]
532
+ },
464
533
  "transcode": {
465
534
  "anyOf": [
466
535
  {
@@ -555,6 +624,10 @@
555
624
  "prompt",
556
625
  "inputSrc",
557
626
  "model",
627
+ "resolution",
628
+ "duration",
629
+ "aspectRatio",
630
+ "generateAudio",
558
631
  "transcode",
559
632
  "trim",
560
633
  "volume",
@@ -810,6 +883,40 @@
810
883
  }
811
884
  ]
812
885
  },
886
+ "resolution": {
887
+ "anyOf": [
888
+ {
889
+ "type": "string",
890
+ "enum": [
891
+ "1K",
892
+ "2K",
893
+ "4K"
894
+ ]
895
+ },
896
+ {
897
+ "type": "null"
898
+ }
899
+ ]
900
+ },
901
+ "aspectRatio": {
902
+ "anyOf": [
903
+ {
904
+ "type": "string",
905
+ "enum": [
906
+ "1:1",
907
+ "16:9",
908
+ "9:16",
909
+ "4:3",
910
+ "3:4",
911
+ "21:9",
912
+ "9:21"
913
+ ]
914
+ },
915
+ {
916
+ "type": "null"
917
+ }
918
+ ]
919
+ },
813
920
  "crop": {
814
921
  "anyOf": [
815
922
  {
@@ -827,6 +934,8 @@
827
934
  "src",
828
935
  "prompt",
829
936
  "model",
937
+ "resolution",
938
+ "aspectRatio",
830
939
  "crop"
831
940
  ]
832
941
  },
@@ -1654,6 +1763,38 @@
1654
1763
  }
1655
1764
  ]
1656
1765
  },
1766
+ "musicLengthMs": {
1767
+ "anyOf": [
1768
+ {
1769
+ "type": "number",
1770
+ "minimum": 3000,
1771
+ "maximum": 600000
1772
+ },
1773
+ {
1774
+ "type": "null"
1775
+ }
1776
+ ]
1777
+ },
1778
+ "forceInstrumental": {
1779
+ "anyOf": [
1780
+ {
1781
+ "type": "boolean"
1782
+ },
1783
+ {
1784
+ "type": "null"
1785
+ }
1786
+ ]
1787
+ },
1788
+ "compositionPlan": {
1789
+ "anyOf": [
1790
+ {
1791
+ "type": "string"
1792
+ },
1793
+ {
1794
+ "type": "null"
1795
+ }
1796
+ ]
1797
+ },
1657
1798
  "trim": {
1658
1799
  "anyOf": [
1659
1800
  {
@@ -1720,6 +1861,9 @@
1720
1861
  "language",
1721
1862
  "newscaster",
1722
1863
  "model",
1864
+ "musicLengthMs",
1865
+ "forceInstrumental",
1866
+ "compositionPlan",
1723
1867
  "trim",
1724
1868
  "volume",
1725
1869
  "speed",