@shotstack/schemas 1.16.0 → 1.18.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.
- package/dist/api.bundled.json +203 -0
- package/dist/json-schema/edit.json +24 -0
- package/dist/json-schema/index.cjs +1 -1
- package/dist/json-schema/index.js +1 -1
- package/dist/schema.d.ts +194 -0
- package/dist/zod/zod.gen.cjs +82 -6
- package/dist/zod/zod.gen.d.ts +445 -0
- package/dist/zod/zod.gen.js +75 -0
- package/dist/zod/zod.gen.ts +72 -0
- package/package.json +1 -1
package/dist/api.bundled.json
CHANGED
|
@@ -639,6 +639,189 @@
|
|
|
639
639
|
}
|
|
640
640
|
]
|
|
641
641
|
},
|
|
642
|
+
"/models": {
|
|
643
|
+
"get": {
|
|
644
|
+
"description": "List the generation models available for `prompt`-bearing image, video and audio\nassets, with the options each accepts and what it costs in credits.\n\nUse this to populate a model picker and render its option fields, rather than\nhard coding a model list. A newly launched model appears here without any change\non your side. Each entry carries the asset type it generates, so filter the list\nclient side when a picker only needs one kind.\n\nOption schemas are omitted by default. Request them with `expand=options`.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>\n",
|
|
645
|
+
"summary": "List Generation Models",
|
|
646
|
+
"operationId": "getModels",
|
|
647
|
+
"responses": {
|
|
648
|
+
"200": {
|
|
649
|
+
"description": "The available generation models.",
|
|
650
|
+
"content": {
|
|
651
|
+
"application/json": {
|
|
652
|
+
"schema": {
|
|
653
|
+
"description": "The generation models available to this account.",
|
|
654
|
+
"properties": {
|
|
655
|
+
"models": {
|
|
656
|
+
"description": "The available models.",
|
|
657
|
+
"type": "array",
|
|
658
|
+
"items": {
|
|
659
|
+
"$ref": "#/paths/~1models~1%7Bid%7D/get/responses/200/content/application~1json/schema"
|
|
660
|
+
}
|
|
661
|
+
}
|
|
662
|
+
},
|
|
663
|
+
"required": [
|
|
664
|
+
"models"
|
|
665
|
+
],
|
|
666
|
+
"type": "object"
|
|
667
|
+
}
|
|
668
|
+
}
|
|
669
|
+
}
|
|
670
|
+
}
|
|
671
|
+
},
|
|
672
|
+
"security": [
|
|
673
|
+
{
|
|
674
|
+
"DeveloperKey": []
|
|
675
|
+
}
|
|
676
|
+
],
|
|
677
|
+
"tags": [
|
|
678
|
+
"Edit"
|
|
679
|
+
]
|
|
680
|
+
},
|
|
681
|
+
"parameters": [
|
|
682
|
+
{
|
|
683
|
+
"in": "query",
|
|
684
|
+
"name": "expand",
|
|
685
|
+
"required": false,
|
|
686
|
+
"description": "Set to `options` to include each model's option schema in the list. Omitted by default to keep the response small.",
|
|
687
|
+
"schema": {
|
|
688
|
+
"type": "string",
|
|
689
|
+
"enum": [
|
|
690
|
+
"options"
|
|
691
|
+
]
|
|
692
|
+
},
|
|
693
|
+
"example": "options"
|
|
694
|
+
}
|
|
695
|
+
]
|
|
696
|
+
},
|
|
697
|
+
"/models/{id}": {
|
|
698
|
+
"get": {
|
|
699
|
+
"description": "Get one generation model, including the JSON Schema for the options it accepts and\nwhat it costs in credits.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>\n",
|
|
700
|
+
"summary": "Get Generation Model",
|
|
701
|
+
"operationId": "getModel",
|
|
702
|
+
"responses": {
|
|
703
|
+
"200": {
|
|
704
|
+
"description": "The generation model, with its option schema.",
|
|
705
|
+
"content": {
|
|
706
|
+
"application/json": {
|
|
707
|
+
"schema": {
|
|
708
|
+
"description": "A generation model available to `prompt`-bearing image, video and audio assets, with the options it accepts and what it costs. Render a model picker and its option fields from this rather than hard coding a model list, so a newly launched model is available without a client release.",
|
|
709
|
+
"properties": {
|
|
710
|
+
"model": {
|
|
711
|
+
"description": "The identifier to set as the asset `model`. Carries no provider name, so routing can change without a public rename.",
|
|
712
|
+
"type": "string",
|
|
713
|
+
"example": "seedance-2.0"
|
|
714
|
+
},
|
|
715
|
+
"type": {
|
|
716
|
+
"description": "The asset type this model generates.",
|
|
717
|
+
"type": "string",
|
|
718
|
+
"enum": [
|
|
719
|
+
"image",
|
|
720
|
+
"video",
|
|
721
|
+
"audio"
|
|
722
|
+
],
|
|
723
|
+
"example": "video"
|
|
724
|
+
},
|
|
725
|
+
"pricing": {
|
|
726
|
+
"description": "What one generation with this model costs.",
|
|
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
|
+
"credits": {
|
|
740
|
+
"description": "Credits per unit. A number when the rate is flat, or an object keyed by the values of the options named in `tieredBy`.",
|
|
741
|
+
"oneOf": [
|
|
742
|
+
{
|
|
743
|
+
"type": "number"
|
|
744
|
+
},
|
|
745
|
+
{
|
|
746
|
+
"type": "object",
|
|
747
|
+
"additionalProperties": true
|
|
748
|
+
}
|
|
749
|
+
],
|
|
750
|
+
"example": {
|
|
751
|
+
"480p": 0.9375,
|
|
752
|
+
"720p": 1.8962,
|
|
753
|
+
"1080p": 4.2625
|
|
754
|
+
}
|
|
755
|
+
},
|
|
756
|
+
"tieredBy": {
|
|
757
|
+
"description": "The options whose values select the rate, outermost first. Absent when `credits` is a single number.",
|
|
758
|
+
"type": "array",
|
|
759
|
+
"items": {
|
|
760
|
+
"type": "string"
|
|
761
|
+
},
|
|
762
|
+
"example": [
|
|
763
|
+
"resolution"
|
|
764
|
+
]
|
|
765
|
+
},
|
|
766
|
+
"minUnits": {
|
|
767
|
+
"description": "The fewest units a generation is charged for, when a model has a minimum charge.",
|
|
768
|
+
"type": "number",
|
|
769
|
+
"example": 0.1
|
|
770
|
+
},
|
|
771
|
+
"effectiveFrom": {
|
|
772
|
+
"description": "The date this rate took effect, or `legacy` for a rate that predates dated pricing.",
|
|
773
|
+
"type": "string",
|
|
774
|
+
"example": "2026-08-13"
|
|
775
|
+
}
|
|
776
|
+
},
|
|
777
|
+
"required": [
|
|
778
|
+
"unit",
|
|
779
|
+
"credits",
|
|
780
|
+
"effectiveFrom"
|
|
781
|
+
],
|
|
782
|
+
"type": "object"
|
|
783
|
+
},
|
|
784
|
+
"options": {
|
|
785
|
+
"description": "JSON Schema for the model's `options` object. Only returned for a single model, or for a list requested with `expand=options`. Values outside this schema are rejected.",
|
|
786
|
+
"type": "object",
|
|
787
|
+
"additionalProperties": true
|
|
788
|
+
}
|
|
789
|
+
},
|
|
790
|
+
"required": [
|
|
791
|
+
"model",
|
|
792
|
+
"type"
|
|
793
|
+
],
|
|
794
|
+
"type": "object"
|
|
795
|
+
}
|
|
796
|
+
}
|
|
797
|
+
}
|
|
798
|
+
},
|
|
799
|
+
"404": {
|
|
800
|
+
"description": "No model exists with that identifier."
|
|
801
|
+
}
|
|
802
|
+
},
|
|
803
|
+
"security": [
|
|
804
|
+
{
|
|
805
|
+
"DeveloperKey": []
|
|
806
|
+
}
|
|
807
|
+
],
|
|
808
|
+
"tags": [
|
|
809
|
+
"Edit"
|
|
810
|
+
]
|
|
811
|
+
},
|
|
812
|
+
"parameters": [
|
|
813
|
+
{
|
|
814
|
+
"in": "path",
|
|
815
|
+
"name": "id",
|
|
816
|
+
"required": true,
|
|
817
|
+
"description": "The model identifier, as returned by the list endpoint.",
|
|
818
|
+
"schema": {
|
|
819
|
+
"type": "string"
|
|
820
|
+
},
|
|
821
|
+
"example": "seedance-2.0"
|
|
822
|
+
}
|
|
823
|
+
]
|
|
824
|
+
},
|
|
642
825
|
"/assets/{id}": {
|
|
643
826
|
"get": {
|
|
644
827
|
"responses": {
|
|
@@ -2070,6 +2253,16 @@
|
|
|
2070
2253
|
"description": "The weight of the font. Can be a number (100-900) or a string ('normal', 'bold', etc.). 100 is lightest, 900 is heaviest (boldest).",
|
|
2071
2254
|
"default": "400"
|
|
2072
2255
|
},
|
|
2256
|
+
"style": {
|
|
2257
|
+
"description": "The font style.",
|
|
2258
|
+
"type": "string",
|
|
2259
|
+
"enum": [
|
|
2260
|
+
"normal",
|
|
2261
|
+
"italic"
|
|
2262
|
+
],
|
|
2263
|
+
"default": "normal",
|
|
2264
|
+
"example": "italic"
|
|
2265
|
+
},
|
|
2073
2266
|
"color": {
|
|
2074
2267
|
"description": "The text color using hexadecimal color notation.",
|
|
2075
2268
|
"type": "string",
|
|
@@ -3173,6 +3366,16 @@
|
|
|
3173
3366
|
"description": "The weight of the font. Can be a number (100-900) or a string ('normal', 'bold', etc.). 100 is lightest, 900 is heaviest (boldest).",
|
|
3174
3367
|
"default": "400"
|
|
3175
3368
|
},
|
|
3369
|
+
"style": {
|
|
3370
|
+
"description": "The font style.",
|
|
3371
|
+
"type": "string",
|
|
3372
|
+
"enum": [
|
|
3373
|
+
"normal",
|
|
3374
|
+
"italic"
|
|
3375
|
+
],
|
|
3376
|
+
"default": "normal",
|
|
3377
|
+
"example": "italic"
|
|
3378
|
+
},
|
|
3176
3379
|
"color": {
|
|
3177
3380
|
"description": "The text color using hexadecimal color notation.",
|
|
3178
3381
|
"type": "string",
|
|
@@ -1728,6 +1728,18 @@
|
|
|
1728
1728
|
"description": "The weight of the font. Can be a number (100-900) or a string ('normal', 'bold', etc.). 100 is lightest, 900 is heaviest (boldest).",
|
|
1729
1729
|
"default": "400"
|
|
1730
1730
|
},
|
|
1731
|
+
"style": {
|
|
1732
|
+
"description": "The font style.",
|
|
1733
|
+
"type": "string",
|
|
1734
|
+
"enum": [
|
|
1735
|
+
"normal",
|
|
1736
|
+
"italic"
|
|
1737
|
+
],
|
|
1738
|
+
"default": "normal",
|
|
1739
|
+
"examples": [
|
|
1740
|
+
"italic"
|
|
1741
|
+
]
|
|
1742
|
+
},
|
|
1731
1743
|
"color": {
|
|
1732
1744
|
"description": "The text color using hexadecimal color notation.",
|
|
1733
1745
|
"type": "string",
|
|
@@ -2197,6 +2209,18 @@
|
|
|
2197
2209
|
"description": "The weight of the font. Can be a number (100-900) or a string ('normal', 'bold', etc.). 100 is lightest, 900 is heaviest (boldest).",
|
|
2198
2210
|
"default": "400"
|
|
2199
2211
|
},
|
|
2212
|
+
"style": {
|
|
2213
|
+
"description": "The font style.",
|
|
2214
|
+
"type": "string",
|
|
2215
|
+
"enum": [
|
|
2216
|
+
"normal",
|
|
2217
|
+
"italic"
|
|
2218
|
+
],
|
|
2219
|
+
"default": "normal",
|
|
2220
|
+
"examples": [
|
|
2221
|
+
"italic"
|
|
2222
|
+
]
|
|
2223
|
+
},
|
|
2200
2224
|
"color": {
|
|
2201
2225
|
"description": "The text color using hexadecimal color notation.",
|
|
2202
2226
|
"type": "string",
|