@shotstack/schemas 1.12.2 → 1.13.0

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.
@@ -294,7 +294,44 @@
294
294
  "type": "string"
295
295
  },
296
296
  "src": {
297
- "type": "string"
297
+ "anyOf": [
298
+ {
299
+ "type": "string"
300
+ },
301
+ {
302
+ "type": "null"
303
+ }
304
+ ]
305
+ },
306
+ "prompt": {
307
+ "anyOf": [
308
+ {
309
+ "type": "string"
310
+ },
311
+ {
312
+ "type": "null"
313
+ }
314
+ ]
315
+ },
316
+ "seed": {
317
+ "anyOf": [
318
+ {
319
+ "type": "string"
320
+ },
321
+ {
322
+ "type": "null"
323
+ }
324
+ ]
325
+ },
326
+ "model": {
327
+ "anyOf": [
328
+ {
329
+ "type": "string"
330
+ },
331
+ {
332
+ "type": "null"
333
+ }
334
+ ]
298
335
  },
299
336
  "transcode": {
300
337
  "anyOf": [
@@ -387,6 +424,9 @@
387
424
  "required": [
388
425
  "type",
389
426
  "src",
427
+ "prompt",
428
+ "seed",
429
+ "model",
390
430
  "transcode",
391
431
  "trim",
392
432
  "volume",
@@ -613,7 +653,34 @@
613
653
  "type": "string"
614
654
  },
615
655
  "src": {
616
- "type": "string"
656
+ "anyOf": [
657
+ {
658
+ "type": "string"
659
+ },
660
+ {
661
+ "type": "null"
662
+ }
663
+ ]
664
+ },
665
+ "prompt": {
666
+ "anyOf": [
667
+ {
668
+ "type": "string"
669
+ },
670
+ {
671
+ "type": "null"
672
+ }
673
+ ]
674
+ },
675
+ "model": {
676
+ "anyOf": [
677
+ {
678
+ "type": "string"
679
+ },
680
+ {
681
+ "type": "null"
682
+ }
683
+ ]
617
684
  },
618
685
  "crop": {
619
686
  "anyOf": [
@@ -630,6 +697,8 @@
630
697
  "required": [
631
698
  "type",
632
699
  "src",
700
+ "prompt",
701
+ "model",
633
702
  "crop"
634
703
  ]
635
704
  },
@@ -1398,7 +1467,64 @@
1398
1467
  "type": "string"
1399
1468
  },
1400
1469
  "src": {
1401
- "type": "string"
1470
+ "anyOf": [
1471
+ {
1472
+ "type": "string"
1473
+ },
1474
+ {
1475
+ "type": "null"
1476
+ }
1477
+ ]
1478
+ },
1479
+ "prompt": {
1480
+ "anyOf": [
1481
+ {
1482
+ "type": "string"
1483
+ },
1484
+ {
1485
+ "type": "null"
1486
+ }
1487
+ ]
1488
+ },
1489
+ "voice": {
1490
+ "anyOf": [
1491
+ {
1492
+ "type": "string"
1493
+ },
1494
+ {
1495
+ "type": "null"
1496
+ }
1497
+ ]
1498
+ },
1499
+ "language": {
1500
+ "anyOf": [
1501
+ {
1502
+ "type": "string"
1503
+ },
1504
+ {
1505
+ "type": "null"
1506
+ }
1507
+ ]
1508
+ },
1509
+ "newscaster": {
1510
+ "anyOf": [
1511
+ {
1512
+ "type": "boolean"
1513
+ },
1514
+ {
1515
+ "type": "null"
1516
+ }
1517
+ ]
1518
+ },
1519
+ "model": {
1520
+ "anyOf": [
1521
+ {
1522
+ "type": "string"
1523
+ },
1524
+ {
1525
+ "type": "null"
1526
+ }
1527
+ ]
1402
1528
  },
1403
1529
  "trim": {
1404
1530
  "anyOf": [
@@ -1461,6 +1587,11 @@
1461
1587
  "required": [
1462
1588
  "type",
1463
1589
  "src",
1590
+ "prompt",
1591
+ "voice",
1592
+ "language",
1593
+ "newscaster",
1594
+ "model",
1464
1595
  "trim",
1465
1596
  "volume",
1466
1597
  "speed",
@@ -478,7 +478,44 @@
478
478
  "type": "string"
479
479
  },
480
480
  "src": {
481
- "type": "string"
481
+ "anyOf": [
482
+ {
483
+ "type": "string"
484
+ },
485
+ {
486
+ "type": "null"
487
+ }
488
+ ]
489
+ },
490
+ "prompt": {
491
+ "anyOf": [
492
+ {
493
+ "type": "string"
494
+ },
495
+ {
496
+ "type": "null"
497
+ }
498
+ ]
499
+ },
500
+ "seed": {
501
+ "anyOf": [
502
+ {
503
+ "type": "string"
504
+ },
505
+ {
506
+ "type": "null"
507
+ }
508
+ ]
509
+ },
510
+ "model": {
511
+ "anyOf": [
512
+ {
513
+ "type": "string"
514
+ },
515
+ {
516
+ "type": "null"
517
+ }
518
+ ]
482
519
  },
483
520
  "transcode": {
484
521
  "anyOf": [
@@ -571,6 +608,9 @@
571
608
  "required": [
572
609
  "type",
573
610
  "src",
611
+ "prompt",
612
+ "seed",
613
+ "model",
574
614
  "transcode",
575
615
  "trim",
576
616
  "volume",
@@ -797,7 +837,34 @@
797
837
  "type": "string"
798
838
  },
799
839
  "src": {
800
- "type": "string"
840
+ "anyOf": [
841
+ {
842
+ "type": "string"
843
+ },
844
+ {
845
+ "type": "null"
846
+ }
847
+ ]
848
+ },
849
+ "prompt": {
850
+ "anyOf": [
851
+ {
852
+ "type": "string"
853
+ },
854
+ {
855
+ "type": "null"
856
+ }
857
+ ]
858
+ },
859
+ "model": {
860
+ "anyOf": [
861
+ {
862
+ "type": "string"
863
+ },
864
+ {
865
+ "type": "null"
866
+ }
867
+ ]
801
868
  },
802
869
  "crop": {
803
870
  "anyOf": [
@@ -814,6 +881,8 @@
814
881
  "required": [
815
882
  "type",
816
883
  "src",
884
+ "prompt",
885
+ "model",
817
886
  "crop"
818
887
  ]
819
888
  },
@@ -1582,7 +1651,64 @@
1582
1651
  "type": "string"
1583
1652
  },
1584
1653
  "src": {
1585
- "type": "string"
1654
+ "anyOf": [
1655
+ {
1656
+ "type": "string"
1657
+ },
1658
+ {
1659
+ "type": "null"
1660
+ }
1661
+ ]
1662
+ },
1663
+ "prompt": {
1664
+ "anyOf": [
1665
+ {
1666
+ "type": "string"
1667
+ },
1668
+ {
1669
+ "type": "null"
1670
+ }
1671
+ ]
1672
+ },
1673
+ "voice": {
1674
+ "anyOf": [
1675
+ {
1676
+ "type": "string"
1677
+ },
1678
+ {
1679
+ "type": "null"
1680
+ }
1681
+ ]
1682
+ },
1683
+ "language": {
1684
+ "anyOf": [
1685
+ {
1686
+ "type": "string"
1687
+ },
1688
+ {
1689
+ "type": "null"
1690
+ }
1691
+ ]
1692
+ },
1693
+ "newscaster": {
1694
+ "anyOf": [
1695
+ {
1696
+ "type": "boolean"
1697
+ },
1698
+ {
1699
+ "type": "null"
1700
+ }
1701
+ ]
1702
+ },
1703
+ "model": {
1704
+ "anyOf": [
1705
+ {
1706
+ "type": "string"
1707
+ },
1708
+ {
1709
+ "type": "null"
1710
+ }
1711
+ ]
1586
1712
  },
1587
1713
  "trim": {
1588
1714
  "anyOf": [
@@ -1645,6 +1771,11 @@
1645
1771
  "required": [
1646
1772
  "type",
1647
1773
  "src",
1774
+ "prompt",
1775
+ "voice",
1776
+ "language",
1777
+ "newscaster",
1778
+ "model",
1648
1779
  "trim",
1649
1780
  "volume",
1650
1781
  "speed",
@@ -2,7 +2,7 @@
2
2
  "name": "ImageAsset",
3
3
  "strict": true,
4
4
  "schema": {
5
- "description": "The ImageAsset is used to create video from images to compose an image. The src must be a publicly accessible URL to an image resource such as a jpg or png file.",
5
+ "description": "The ImageAsset adds an image to a Clip. The image can be sourced from a URL\n(`src`) or generated from a text prompt (`prompt`). Exactly one of `src` or\n`prompt` must be provided.\n\n- **Source URL:** set `src` to the publicly accessible URL of a jpg or png file.\n- **Generated:** set `prompt` to describe the image; the engine generates it\n using the provider chosen by `model` and fills `src` in automatically.\n",
6
6
  "type": "object",
7
7
  "properties": {
8
8
  "type": {
@@ -13,8 +13,37 @@
13
13
  "type": "string"
14
14
  },
15
15
  "src": {
16
- "description": "The image source URL. The URL must be publicly accessible or include credentials.",
17
- "type": "string"
16
+ "anyOf": [
17
+ {
18
+ "type": "string",
19
+ "description": "The image source URL. The URL must be publicly accessible or include credentials. Provide either `src` or `prompt`, not both."
20
+ },
21
+ {
22
+ "type": "null"
23
+ }
24
+ ]
25
+ },
26
+ "prompt": {
27
+ "anyOf": [
28
+ {
29
+ "type": "string",
30
+ "description": "A text prompt to generate the image from. When set without `src`, the engine generates an image and fills `src` automatically. Use `model` to choose the generator."
31
+ },
32
+ {
33
+ "type": "null"
34
+ }
35
+ ]
36
+ },
37
+ "model": {
38
+ "anyOf": [
39
+ {
40
+ "type": "string",
41
+ "description": "The generation model to use when `prompt` is set (e.g. `flux-schnell`). Defaults to the platform's preferred generator if omitted."
42
+ },
43
+ {
44
+ "type": "null"
45
+ }
46
+ ]
18
47
  },
19
48
  "crop": {
20
49
  "anyOf": [
@@ -31,6 +60,8 @@
31
60
  "required": [
32
61
  "type",
33
62
  "src",
63
+ "prompt",
64
+ "model",
34
65
  "crop"
35
66
  ],
36
67
  "$defs": {
@@ -2,7 +2,7 @@
2
2
  "name": "ImageToVideoAsset",
3
3
  "strict": true,
4
4
  "schema": {
5
- "description": "The ImageToVideoAsset lets you create a video from an image and a text prompt.",
5
+ "description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt` and `seed` instead.** This type continues to function and is\ninternally rewritten to VideoAsset; no behaviour change for existing\nintegrations.\n\nThe ImageToVideoAsset lets you create a video from an image and a text prompt.\n",
6
6
  "properties": {
7
7
  "type": {
8
8
  "type": "string",
@@ -450,7 +450,7 @@
450
450
  ]
451
451
  },
452
452
  "VideoAsset": {
453
- "description": "The VideoAsset is used to create video sequences from video files. The src must be a publicly accessible URL to a video resource such as an mp4 file.",
453
+ "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 seeded from a\nstarting image (`seed`). Exactly one of `src` or `prompt` must be provided.\n\n- **Source URL:** set `src` to the URL of an mp4 (or compatible) video file.\n- **Generated:** set `prompt` to describe the motion. Optionally set `seed` to\n a starting image URL (image-to-video). Use `model` to choose the generator\n (e.g. `luma-ray-3`, `runpod-itv-mini`). The generated `src` is filled in\n automatically.\n",
454
454
  "type": "object",
455
455
  "properties": {
456
456
  "type": {
@@ -461,8 +461,48 @@
461
461
  "type": "string"
462
462
  },
463
463
  "src": {
464
- "description": "The video source URL. The URL must be publicly accessible or include credentials.",
465
- "type": "string"
464
+ "anyOf": [
465
+ {
466
+ "type": "string",
467
+ "description": "The video source URL. The URL must be publicly accessible or include credentials. Provide either `src` or `prompt`, not both."
468
+ },
469
+ {
470
+ "type": "null"
471
+ }
472
+ ]
473
+ },
474
+ "prompt": {
475
+ "anyOf": [
476
+ {
477
+ "type": "string",
478
+ "description": "A text prompt to generate the video from. When set without `src`, the engine generates a video and fills `src` automatically. Optionally pair with `seed` for image-to-video. Use `model` to choose the generator."
479
+ },
480
+ {
481
+ "type": "null"
482
+ }
483
+ ]
484
+ },
485
+ "seed": {
486
+ "anyOf": [
487
+ {
488
+ "type": "string",
489
+ "description": "Seed image URL for image-to-video generation. The image is used as the starting frame; `prompt` describes the motion. Has no effect unless `prompt` is set."
490
+ },
491
+ {
492
+ "type": "null"
493
+ }
494
+ ]
495
+ },
496
+ "model": {
497
+ "anyOf": [
498
+ {
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."
501
+ },
502
+ {
503
+ "type": "null"
504
+ }
505
+ ]
466
506
  },
467
507
  "transcode": {
468
508
  "anyOf": [
@@ -528,7 +568,7 @@
528
568
  "anyOf": [
529
569
  {
530
570
  "type": "number",
531
- "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 adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire video (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire video (i.e. original length / 2).",
571
+ "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 adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire video (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire video (i.e. original length / 2).",
532
572
  "minimum": 0,
533
573
  "maximum": 10
534
574
  },
@@ -562,6 +602,9 @@
562
602
  "required": [
563
603
  "type",
564
604
  "src",
605
+ "prompt",
606
+ "seed",
607
+ "model",
565
608
  "transcode",
566
609
  "trim",
567
610
  "volume",
@@ -795,7 +838,7 @@
795
838
  "type": "object"
796
839
  },
797
840
  "ImageAsset": {
798
- "description": "The ImageAsset is used to create video from images to compose an image. The src must be a publicly accessible URL to an image resource such as a jpg or png file.",
841
+ "description": "The ImageAsset adds an image to a Clip. The image can be sourced from a URL\n(`src`) or generated from a text prompt (`prompt`). Exactly one of `src` or\n`prompt` must be provided.\n\n- **Source URL:** set `src` to the publicly accessible URL of a jpg or png file.\n- **Generated:** set `prompt` to describe the image; the engine generates it\n using the provider chosen by `model` and fills `src` in automatically.\n",
799
842
  "type": "object",
800
843
  "properties": {
801
844
  "type": {
@@ -806,8 +849,37 @@
806
849
  "type": "string"
807
850
  },
808
851
  "src": {
809
- "description": "The image source URL. The URL must be publicly accessible or include credentials.",
810
- "type": "string"
852
+ "anyOf": [
853
+ {
854
+ "type": "string",
855
+ "description": "The image source URL. The URL must be publicly accessible or include credentials. Provide either `src` or `prompt`, not both."
856
+ },
857
+ {
858
+ "type": "null"
859
+ }
860
+ ]
861
+ },
862
+ "prompt": {
863
+ "anyOf": [
864
+ {
865
+ "type": "string",
866
+ "description": "A text prompt to generate the image from. When set without `src`, the engine generates an image and fills `src` automatically. Use `model` to choose the generator."
867
+ },
868
+ {
869
+ "type": "null"
870
+ }
871
+ ]
872
+ },
873
+ "model": {
874
+ "anyOf": [
875
+ {
876
+ "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."
878
+ },
879
+ {
880
+ "type": "null"
881
+ }
882
+ ]
811
883
  },
812
884
  "crop": {
813
885
  "anyOf": [
@@ -824,6 +896,8 @@
824
896
  "required": [
825
897
  "type",
826
898
  "src",
899
+ "prompt",
900
+ "model",
827
901
  "crop"
828
902
  ]
829
903
  },
@@ -1650,7 +1724,7 @@
1650
1724
  "type": "object"
1651
1725
  },
1652
1726
  "AudioAsset": {
1653
- "description": "The AudioAsset is used to add sound effects and audio at specific intervals on the timeline. The src must be a publicly accessible URL to an audio resource such as an mp3 file.",
1727
+ "description": "The AudioAsset adds audio to a Clip. The audio can be sourced from a URL\n(`src`) or generated from a text prompt (`prompt`). Exactly one of `src` or\n`prompt` must be provided.\n\n- **Source URL:** set `src` to a publicly accessible audio URL (e.g. mp3).\n- **Generated speech:** set `prompt` to the spoken text and `voice` to a voice\n identifier (text-to-speech). Optionally set `language`/`newscaster`.\n- **Generated music or SFX:** set `prompt` describing the sound; omit `voice`.\n- Use `model` to choose the generator. The generated `src` is filled in\n automatically.\n",
1654
1728
  "type": "object",
1655
1729
  "properties": {
1656
1730
  "type": {
@@ -1661,8 +1735,70 @@
1661
1735
  "type": "string"
1662
1736
  },
1663
1737
  "src": {
1664
- "description": "The audio source URL. The URL must be publicly accessible or include credentials.",
1665
- "type": "string"
1738
+ "anyOf": [
1739
+ {
1740
+ "type": "string",
1741
+ "description": "The audio source URL. The URL must be publicly accessible or include credentials. Provide either `src` or `prompt`, not both."
1742
+ },
1743
+ {
1744
+ "type": "null"
1745
+ }
1746
+ ]
1747
+ },
1748
+ "prompt": {
1749
+ "anyOf": [
1750
+ {
1751
+ "type": "string",
1752
+ "description": "A text prompt. When `voice` is set, the prompt is the spoken text (text-to-speech). Without `voice`, the prompt describes generated music or sound effects. The generated `src` is filled in automatically."
1753
+ },
1754
+ {
1755
+ "type": "null"
1756
+ }
1757
+ ]
1758
+ },
1759
+ "voice": {
1760
+ "anyOf": [
1761
+ {
1762
+ "type": "string",
1763
+ "description": "Voice identifier for text-to-speech generation (e.g. `Matthew`, `Joanna`). Only meaningful when `prompt` is set."
1764
+ },
1765
+ {
1766
+ "type": "null"
1767
+ }
1768
+ ]
1769
+ },
1770
+ "language": {
1771
+ "anyOf": [
1772
+ {
1773
+ "type": "string",
1774
+ "description": "Optional BCP-47 language code (e.g. `en-US`) for text-to-speech. Only meaningful when `prompt` and `voice` are set."
1775
+ },
1776
+ {
1777
+ "type": "null"
1778
+ }
1779
+ ]
1780
+ },
1781
+ "newscaster": {
1782
+ "anyOf": [
1783
+ {
1784
+ "type": "boolean",
1785
+ "description": "Set to `true` to use the voice's newscaster mode when supported. Only meaningful when `prompt` and `voice` are set."
1786
+ },
1787
+ {
1788
+ "type": "null"
1789
+ }
1790
+ ]
1791
+ },
1792
+ "model": {
1793
+ "anyOf": [
1794
+ {
1795
+ "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."
1797
+ },
1798
+ {
1799
+ "type": "null"
1800
+ }
1801
+ ]
1666
1802
  },
1667
1803
  "trim": {
1668
1804
  "anyOf": [
@@ -1700,7 +1836,7 @@
1700
1836
  "anyOf": [
1701
1837
  {
1702
1838
  "type": "number",
1703
- "description": "Adjust the playback speed of the audio clip between 0 (paused) and 10 (10x normal speed), where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire audio (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire audio (i.e. original length / 2).",
1839
+ "description": "Adjust the playback speed of the audio clip between 0 (paused) and 10 (10x normal speed), where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire audio (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire audio (i.e. original length / 2).",
1704
1840
  "minimum": 0,
1705
1841
  "maximum": 10
1706
1842
  },
@@ -1731,6 +1867,11 @@
1731
1867
  "required": [
1732
1868
  "type",
1733
1869
  "src",
1870
+ "prompt",
1871
+ "voice",
1872
+ "language",
1873
+ "newscaster",
1874
+ "model",
1734
1875
  "trim",
1735
1876
  "volume",
1736
1877
  "speed",
@@ -2821,7 +2962,7 @@
2821
2962
  ]
2822
2963
  },
2823
2964
  "TextToImageAsset": {
2824
- "description": "The TextToImageAsset lets you create a dynamic image from a text prompt.",
2965
+ "description": "**Notice: TextToImageAsset is deprecated. Use [ImageAsset](#tocs_imageasset)\nwith `prompt` instead.** This type continues to function and is internally\nrewritten to ImageAsset; no behaviour change for existing integrations.\n\nThe TextToImageAsset lets you create a dynamic image from a text prompt.\n",
2825
2966
  "properties": {
2826
2967
  "type": {
2827
2968
  "type": "string",
@@ -2878,7 +3019,7 @@
2878
3019
  ]
2879
3020
  },
2880
3021
  "ImageToVideoAsset": {
2881
- "description": "The ImageToVideoAsset lets you create a video from an image and a text prompt.",
3022
+ "description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt` and `seed` instead.** This type continues to function and is\ninternally rewritten to VideoAsset; no behaviour change for existing\nintegrations.\n\nThe ImageToVideoAsset lets you create a video from an image and a text prompt.\n",
2882
3023
  "properties": {
2883
3024
  "type": {
2884
3025
  "type": "string",
@@ -2958,7 +3099,7 @@
2958
3099
  ]
2959
3100
  },
2960
3101
  "TextToSpeechAsset": {
2961
- "description": "The TextToSpeechAsset lets you generate a voice over from text using a text-to-speech service. The generated audio can be trimmed, faded and have its volume and speed adjusted using the same properties available on the AudioAsset.",
3102
+ "description": "**Notice: TextToSpeechAsset is deprecated. Use [AudioAsset](#tocs_audioasset)\nwith `prompt` (the spoken text) and `voice` instead.** This type continues to\nfunction and is internally rewritten to AudioAsset; no behaviour change for\nexisting integrations.\n\nThe TextToSpeechAsset lets you generate a voice over from text using a text-to-speech service.\nThe generated audio can be trimmed, faded and have its volume and speed adjusted using the\nsame properties available on the AudioAsset.\n",
2962
3103
  "type": "object",
2963
3104
  "properties": {
2964
3105
  "type": {