@shotstack/schemas 1.18.0 → 1.18.2
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.
- package/dist/api.bundled.json +68 -28
- package/dist/json-schema/edit.json +5 -4
- package/dist/json-schema/index.cjs +1 -1
- package/dist/json-schema/index.js +1 -1
- package/dist/schema.d.ts +57 -27
- package/dist/zod/zod.gen.cjs +49 -20
- package/dist/zod/zod.gen.d.ts +102 -46
- package/dist/zod/zod.gen.js +49 -20
- package/dist/zod/zod.gen.ts +25 -14
- package/package.json +1 -1
package/dist/api.bundled.json
CHANGED
|
@@ -725,19 +725,8 @@
|
|
|
725
725
|
"pricing": {
|
|
726
726
|
"description": "What one generation with this model costs.",
|
|
727
727
|
"properties": {
|
|
728
|
-
"unit": {
|
|
729
|
-
"description": "What one unit is. `render` means the whole generation counts as one unit, whatever its size.",
|
|
730
|
-
"type": "string",
|
|
731
|
-
"enum": [
|
|
732
|
-
"render",
|
|
733
|
-
"second",
|
|
734
|
-
"minute",
|
|
735
|
-
"thousandCharacters"
|
|
736
|
-
],
|
|
737
|
-
"example": "second"
|
|
738
|
-
},
|
|
739
728
|
"credits": {
|
|
740
|
-
"description": "Credits per unit. A number when the rate is flat, or an object keyed by the values of the
|
|
729
|
+
"description": "Credits per unit. A number when the rate is flat, or an object keyed by the values of the option named in `tieredBy`.",
|
|
741
730
|
"oneOf": [
|
|
742
731
|
{
|
|
743
732
|
"type": "number"
|
|
@@ -754,19 +743,69 @@
|
|
|
754
743
|
}
|
|
755
744
|
},
|
|
756
745
|
"tieredBy": {
|
|
757
|
-
"description": "The
|
|
758
|
-
"type": "
|
|
759
|
-
"
|
|
760
|
-
"
|
|
746
|
+
"description": "The option whose value selects the rate, and the value assumed when the option is absent. Present only when `credits` is keyed.",
|
|
747
|
+
"type": "object",
|
|
748
|
+
"properties": {
|
|
749
|
+
"option": {
|
|
750
|
+
"type": "string",
|
|
751
|
+
"example": "resolution"
|
|
752
|
+
},
|
|
753
|
+
"default": {
|
|
754
|
+
"type": "string",
|
|
755
|
+
"example": "720p"
|
|
756
|
+
}
|
|
761
757
|
},
|
|
762
|
-
"
|
|
763
|
-
"
|
|
758
|
+
"required": [
|
|
759
|
+
"option",
|
|
760
|
+
"default"
|
|
764
761
|
]
|
|
765
762
|
},
|
|
766
|
-
"
|
|
767
|
-
"description": "
|
|
768
|
-
"type": "
|
|
769
|
-
"
|
|
763
|
+
"quantity": {
|
|
764
|
+
"description": "How many units a generation consumes. Take the value `measure` names, or `default` when the request carries none, hold it within `min` and `max`, divide by `per`, and round up when `round` is `up`. Absent when one generation is one unit.",
|
|
765
|
+
"type": "object",
|
|
766
|
+
"properties": {
|
|
767
|
+
"measure": {
|
|
768
|
+
"description": "What the count is taken from, and the scale it is measured in.",
|
|
769
|
+
"type": "string",
|
|
770
|
+
"enum": [
|
|
771
|
+
"clipSeconds",
|
|
772
|
+
"promptCharacters"
|
|
773
|
+
],
|
|
774
|
+
"example": "clipSeconds"
|
|
775
|
+
},
|
|
776
|
+
"per": {
|
|
777
|
+
"description": "How many of `measure` make one billable unit.",
|
|
778
|
+
"type": "number",
|
|
779
|
+
"example": 60
|
|
780
|
+
},
|
|
781
|
+
"min": {
|
|
782
|
+
"description": "Fewest accepted. A smaller request is charged at this.",
|
|
783
|
+
"type": "number",
|
|
784
|
+
"example": 3
|
|
785
|
+
},
|
|
786
|
+
"max": {
|
|
787
|
+
"description": "Most accepted. A larger request is charged at this.",
|
|
788
|
+
"type": "number",
|
|
789
|
+
"example": 600
|
|
790
|
+
},
|
|
791
|
+
"default": {
|
|
792
|
+
"description": "Assumed when the request carries no value.",
|
|
793
|
+
"type": "number",
|
|
794
|
+
"example": 30
|
|
795
|
+
},
|
|
796
|
+
"round": {
|
|
797
|
+
"description": "Present when a partial unit is charged as a whole one. A 61 second track on a per-minute rate is charged as two minutes.",
|
|
798
|
+
"type": "string",
|
|
799
|
+
"enum": [
|
|
800
|
+
"up"
|
|
801
|
+
],
|
|
802
|
+
"example": "up"
|
|
803
|
+
}
|
|
804
|
+
},
|
|
805
|
+
"required": [
|
|
806
|
+
"measure",
|
|
807
|
+
"per"
|
|
808
|
+
]
|
|
770
809
|
},
|
|
771
810
|
"effectiveFrom": {
|
|
772
811
|
"description": "The date this rate took effect, or `legacy` for a rate that predates dated pricing.",
|
|
@@ -775,7 +814,6 @@
|
|
|
775
814
|
}
|
|
776
815
|
},
|
|
777
816
|
"required": [
|
|
778
|
-
"unit",
|
|
779
817
|
"credits",
|
|
780
818
|
"effectiveFrom"
|
|
781
819
|
],
|
|
@@ -1533,7 +1571,7 @@
|
|
|
1533
1571
|
"additionalProperties": false
|
|
1534
1572
|
},
|
|
1535
1573
|
"VideoAsset": {
|
|
1536
|
-
"description": "The VideoAsset adds a video to a Clip. The video can be sourced from a URL\n(`src`), generated from a text prompt (`prompt`), or both. At least one of\n`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. Choose a generator\n with `model` and configure it with model-specific `options
|
|
1574
|
+
"description": "The VideoAsset adds a video to a Clip. The video can be sourced from a URL\n(`src`), generated from a text prompt (`prompt`), or both. At least one of\n`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. Choose a generator\n with `model` and configure it with model-specific `options`. Models that\n animate a starting image take it as `options.inputSrc`; the default model\n generates from the prompt alone. The generated `src` is filled in\n automatically.\n- **Both:** `src` acts as a preview placeholder while `prompt` drives\n generation — the video is regenerated from the prompt at render time.\n Unchanged prompts and options resolve from the generation cache.\n",
|
|
1537
1575
|
"type": "object",
|
|
1538
1576
|
"properties": {
|
|
1539
1577
|
"type": {
|
|
@@ -1552,7 +1590,7 @@
|
|
|
1552
1590
|
"example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/video.mp4"
|
|
1553
1591
|
},
|
|
1554
1592
|
"prompt": {
|
|
1555
|
-
"description": "A text prompt to generate the video from. The engine generates a video at render time and fills `src` automatically; an existing `src` is treated as a preview placeholder and replaced. Use `model` to choose the generator and `options` to configure it
|
|
1593
|
+
"description": "A text prompt to generate the video from. The engine generates a video at render time and fills `src` automatically; an existing `src` is treated as a preview placeholder and replaced. Use `model` to choose the generator and `options` to configure it. A starting image goes in `options.inputSrc`, on the models that accept one.",
|
|
1556
1594
|
"type": "string",
|
|
1557
1595
|
"maxLength": 4000,
|
|
1558
1596
|
"example": "Slowly zoom out and orbit left around the object."
|
|
@@ -2164,7 +2202,8 @@
|
|
|
2164
2202
|
]
|
|
2165
2203
|
},
|
|
2166
2204
|
"CaptionAsset": {
|
|
2167
|
-
"
|
|
2205
|
+
"deprecated": true,
|
|
2206
|
+
"description": "**Notice: The CaptionAsset is deprecated, use the [RichCaptionAsset](#tocs_richcaptionasset) instead.**\n\nThe CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will\nbe read and burnt to the video.\n\nCaptions can be applied independently from a video or audio file for greater\nflexibility with styling and layout. For example you can scale, position or crop a video without modifying the\ncaptions.\n\nTo sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with\nmatching start and end time.\n",
|
|
2168
2207
|
"type": "object",
|
|
2169
2208
|
"properties": {
|
|
2170
2209
|
"type": {
|
|
@@ -2563,7 +2602,7 @@
|
|
|
2563
2602
|
},
|
|
2564
2603
|
"ImageToVideoAsset": {
|
|
2565
2604
|
"deprecated": true,
|
|
2566
|
-
"description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt` and `inputSrc`
|
|
2605
|
+
"description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt`, a `model` that accepts a starting image, and that image in\n`options.inputSrc` — for example `shotstack-itv-mini`.** This type continues to\nfunction and is internally rewritten to VideoAsset; no behaviour change for\nexisting integrations.\n\nThe ImageToVideoAsset lets you create a video from an image and a text prompt.\n",
|
|
2567
2606
|
"properties": {
|
|
2568
2607
|
"type": {
|
|
2569
2608
|
"type": "string",
|
|
@@ -4965,12 +5004,13 @@
|
|
|
4965
5004
|
"example": "basic"
|
|
4966
5005
|
},
|
|
4967
5006
|
"status": {
|
|
4968
|
-
"description": "The status of the render task. <ul>\n <li>`queued` - render is queued waiting to be rendered</li>\n <li>`fetching` - assets are being fetched</li>\n <li>`preprocessing` - video assets are being processed for compatibility</li>\n <li>`rendering` - the asset is being rendered</li>\n <li>`saving` - the final asset is being saved to storage</li>\n <li>`done` - the asset is ready to be downloaded</li>\n <li>`failed` - there was an error rendering the asset</li>\n</ul>",
|
|
5007
|
+
"description": "The status of the render task. <ul>\n <li>`queued` - render is queued waiting to be rendered</li>\n <li>`fetching` - assets are being fetched</li>\n <li>`preprocessing` - video assets are being processed for compatibility</li>\n <li>`rendering` - the asset is being rendered</li>\n <li>`generating` - AI/media generation is in progress</li>\n <li>`saving` - the final asset is being saved to storage</li>\n <li>`done` - the asset is ready to be downloaded</li>\n <li>`failed` - there was an error rendering the asset</li>\n</ul>",
|
|
4969
5008
|
"enum": [
|
|
4970
5009
|
"queued",
|
|
4971
5010
|
"fetching",
|
|
4972
5011
|
"preprocessing",
|
|
4973
5012
|
"rendering",
|
|
5013
|
+
"generating",
|
|
4974
5014
|
"saving",
|
|
4975
5015
|
"done",
|
|
4976
5016
|
"failed"
|
|
@@ -202,7 +202,8 @@
|
|
|
202
202
|
]
|
|
203
203
|
},
|
|
204
204
|
"CaptionAsset": {
|
|
205
|
-
"
|
|
205
|
+
"deprecated": true,
|
|
206
|
+
"description": "**Notice: The CaptionAsset is deprecated, use the [RichCaptionAsset](#tocs_richcaptionasset) instead.**\n\nThe CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will\nbe read and burnt to the video.\n\nCaptions can be applied independently from a video or audio file for greater\nflexibility with styling and layout. For example you can scale, position or crop a video without modifying the\ncaptions.\n\nTo sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with\nmatching start and end time.",
|
|
206
207
|
"type": "object",
|
|
207
208
|
"properties": {
|
|
208
209
|
"type": {
|
|
@@ -1152,7 +1153,7 @@
|
|
|
1152
1153
|
},
|
|
1153
1154
|
"ImageToVideoAsset": {
|
|
1154
1155
|
"deprecated": true,
|
|
1155
|
-
"description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt` and `inputSrc`
|
|
1156
|
+
"description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt`, a `model` that accepts a starting image, and that image in\n`options.inputSrc` — for example `shotstack-itv-mini`.** This type continues to\nfunction and is internally rewritten to VideoAsset; no behaviour change for\nexisting integrations.\n\nThe ImageToVideoAsset lets you create a video from an image and a text prompt.",
|
|
1156
1157
|
"properties": {
|
|
1157
1158
|
"type": {
|
|
1158
1159
|
"type": "string",
|
|
@@ -3675,7 +3676,7 @@
|
|
|
3675
3676
|
"type": "object"
|
|
3676
3677
|
},
|
|
3677
3678
|
"VideoAsset": {
|
|
3678
|
-
"description": "The VideoAsset adds a video to a Clip. The video can be sourced from a URL\n(`src`), generated from a text prompt (`prompt`), or both. At least one of\n`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. Choose a generator\n with `model` and configure it with model-specific `options
|
|
3679
|
+
"description": "The VideoAsset adds a video to a Clip. The video can be sourced from a URL\n(`src`), generated from a text prompt (`prompt`), or both. At least one of\n`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. Choose a generator\n with `model` and configure it with model-specific `options`. Models that\n animate a starting image take it as `options.inputSrc`; the default model\n generates from the prompt alone. The generated `src` is filled in\n automatically.\n- **Both:** `src` acts as a preview placeholder while `prompt` drives\n generation — the video is regenerated from the prompt at render time.\n Unchanged prompts and options resolve from the generation cache.",
|
|
3679
3680
|
"type": "object",
|
|
3680
3681
|
"properties": {
|
|
3681
3682
|
"type": {
|
|
@@ -3696,7 +3697,7 @@
|
|
|
3696
3697
|
]
|
|
3697
3698
|
},
|
|
3698
3699
|
"prompt": {
|
|
3699
|
-
"description": "A text prompt to generate the video from. The engine generates a video at render time and fills `src` automatically; an existing `src` is treated as a preview placeholder and replaced. Use `model` to choose the generator and `options` to configure it
|
|
3700
|
+
"description": "A text prompt to generate the video from. The engine generates a video at render time and fills `src` automatically; an existing `src` is treated as a preview placeholder and replaced. Use `model` to choose the generator and `options` to configure it. A starting image goes in `options.inputSrc`, on the models that accept one.",
|
|
3700
3701
|
"type": "string",
|
|
3701
3702
|
"maxLength": 4000,
|
|
3702
3703
|
"examples": [
|