@shotstack/schemas 1.18.3 → 1.19.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 +26 -1
- package/dist/schema.d.ts +24 -0
- package/dist/zod/zod.gen.cjs +9 -1
- package/dist/zod/zod.gen.d.ts +32 -0
- package/dist/zod/zod.gen.js +9 -1
- package/dist/zod/zod.gen.ts +9 -1
- package/package.json +1 -1
package/dist/api.bundled.json
CHANGED
|
@@ -641,7 +641,7 @@
|
|
|
641
641
|
},
|
|
642
642
|
"/models": {
|
|
643
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",
|
|
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\nEach model's `available` reflects the plan of the account behind the calling API\nkey, so offer only the models it marks available.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>\n",
|
|
645
645
|
"summary": "List Generation Models",
|
|
646
646
|
"operationId": "getModels",
|
|
647
647
|
"responses": {
|
|
@@ -722,6 +722,16 @@
|
|
|
722
722
|
],
|
|
723
723
|
"example": "video"
|
|
724
724
|
},
|
|
725
|
+
"name": {
|
|
726
|
+
"description": "The model's display name, for a model picker.",
|
|
727
|
+
"type": "string",
|
|
728
|
+
"example": "Seedance 2.0 · Text to video"
|
|
729
|
+
},
|
|
730
|
+
"description": {
|
|
731
|
+
"description": "What the model is suited to, in a sentence or two.",
|
|
732
|
+
"type": "string",
|
|
733
|
+
"example": "Generate cinematic video with realistic motion, prompt-directed camera movement and optional synchronised audio."
|
|
734
|
+
},
|
|
725
735
|
"pricing": {
|
|
726
736
|
"description": "What one generation with this model costs.",
|
|
727
737
|
"properties": {
|
|
@@ -823,6 +833,21 @@
|
|
|
823
833
|
"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.",
|
|
824
834
|
"type": "object",
|
|
825
835
|
"additionalProperties": true
|
|
836
|
+
},
|
|
837
|
+
"available": {
|
|
838
|
+
"description": "Whether the account behind the calling API key can generate with this model. Omitted when that cannot be determined; treat a missing value as unknown, not as available. Generation requests are checked either way.",
|
|
839
|
+
"type": "boolean",
|
|
840
|
+
"example": false
|
|
841
|
+
},
|
|
842
|
+
"unavailableReason": {
|
|
843
|
+
"description": "Why `available` is false. `AiCapabilityNotIncluded`: the account's plan does not include this kind of generation. `AiDisabled`: AI generation is turned off for the account. `AiAccessUnavailable`: access could not be confirmed; try again later.",
|
|
844
|
+
"type": "string",
|
|
845
|
+
"enum": [
|
|
846
|
+
"AiCapabilityNotIncluded",
|
|
847
|
+
"AiDisabled",
|
|
848
|
+
"AiAccessUnavailable"
|
|
849
|
+
],
|
|
850
|
+
"example": "AiCapabilityNotIncluded"
|
|
826
851
|
}
|
|
827
852
|
},
|
|
828
853
|
"required": [
|
package/dist/schema.d.ts
CHANGED
|
@@ -271,6 +271,9 @@ export interface paths {
|
|
|
271
271
|
*
|
|
272
272
|
* Option schemas are omitted by default. Request them with `expand=options`.
|
|
273
273
|
*
|
|
274
|
+
* Each model's `available` reflects the plan of the account behind the calling API
|
|
275
|
+
* key, so offer only the models it marks available.
|
|
276
|
+
*
|
|
274
277
|
* **Base URL:** <a href="#">https://api.shotstack.io/edit/{version}</a>
|
|
275
278
|
*/
|
|
276
279
|
get: operations["getModels"];
|
|
@@ -4045,6 +4048,16 @@ export interface operations {
|
|
|
4045
4048
|
* @enum {string}
|
|
4046
4049
|
*/
|
|
4047
4050
|
type: "image" | "video" | "audio";
|
|
4051
|
+
/**
|
|
4052
|
+
* @description The model's display name, for a model picker.
|
|
4053
|
+
* @example Seedance 2.0 · Text to video
|
|
4054
|
+
*/
|
|
4055
|
+
name?: string;
|
|
4056
|
+
/**
|
|
4057
|
+
* @description What the model is suited to, in a sentence or two.
|
|
4058
|
+
* @example Generate cinematic video with realistic motion, prompt-directed camera movement and optional synchronised audio.
|
|
4059
|
+
*/
|
|
4060
|
+
description?: string;
|
|
4048
4061
|
/** @description What one generation with this model costs. */
|
|
4049
4062
|
pricing?: {
|
|
4050
4063
|
/**
|
|
@@ -4110,6 +4123,17 @@ export interface operations {
|
|
|
4110
4123
|
options?: {
|
|
4111
4124
|
[key: string]: unknown;
|
|
4112
4125
|
};
|
|
4126
|
+
/**
|
|
4127
|
+
* @description Whether the account behind the calling API key can generate with this model. Omitted when that cannot be determined; treat a missing value as unknown, not as available. Generation requests are checked either way.
|
|
4128
|
+
* @example false
|
|
4129
|
+
*/
|
|
4130
|
+
available?: boolean;
|
|
4131
|
+
/**
|
|
4132
|
+
* @description Why `available` is false. `AiCapabilityNotIncluded`: the account's plan does not include this kind of generation. `AiDisabled`: AI generation is turned off for the account. `AiAccessUnavailable`: access could not be confirmed; try again later.
|
|
4133
|
+
* @example AiCapabilityNotIncluded
|
|
4134
|
+
* @enum {string}
|
|
4135
|
+
*/
|
|
4136
|
+
unavailableReason?: "AiCapabilityNotIncluded" | "AiDisabled" | "AiAccessUnavailable";
|
|
4113
4137
|
};
|
|
4114
4138
|
};
|
|
4115
4139
|
};
|
package/dist/zod/zod.gen.cjs
CHANGED
|
@@ -490,8 +490,16 @@ exports.generationmodelGenerationModelSchema = zod_1.z.object({
|
|
|
490
490
|
'video',
|
|
491
491
|
'audio'
|
|
492
492
|
]),
|
|
493
|
+
name: zod_1.z.optional(zod_1.z.string()),
|
|
494
|
+
description: zod_1.z.optional(zod_1.z.string()),
|
|
493
495
|
pricing: zod_1.z.optional(exports.generationmodelpricingGenerationModelPricingSchema),
|
|
494
|
-
options: zod_1.z.optional(zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()))
|
|
496
|
+
options: zod_1.z.optional(zod_1.z.record(zod_1.z.string(), zod_1.z.unknown())),
|
|
497
|
+
available: zod_1.z.optional(zod_1.z.boolean()),
|
|
498
|
+
unavailableReason: zod_1.z.optional(zod_1.z.enum([
|
|
499
|
+
'AiCapabilityNotIncluded',
|
|
500
|
+
'AiDisabled',
|
|
501
|
+
'AiAccessUnavailable'
|
|
502
|
+
]))
|
|
495
503
|
}).strict();
|
|
496
504
|
/**
|
|
497
505
|
* The Html5Asset renders full HTML5/CSS3/JS.
|
package/dist/zod/zod.gen.d.ts
CHANGED
|
@@ -794,6 +794,8 @@ export declare const generationmodelGenerationModelSchema: z.ZodObject<{
|
|
|
794
794
|
video: "video";
|
|
795
795
|
audio: "audio";
|
|
796
796
|
}>;
|
|
797
|
+
name: z.ZodOptional<z.ZodString>;
|
|
798
|
+
description: z.ZodOptional<z.ZodString>;
|
|
797
799
|
pricing: z.ZodOptional<z.ZodObject<{
|
|
798
800
|
credits: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
|
|
799
801
|
tieredBy: z.ZodOptional<z.ZodObject<{
|
|
@@ -816,6 +818,12 @@ export declare const generationmodelGenerationModelSchema: z.ZodObject<{
|
|
|
816
818
|
effectiveFrom: z.ZodString;
|
|
817
819
|
}, z.core.$strict>>;
|
|
818
820
|
options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
821
|
+
available: z.ZodOptional<z.ZodBoolean>;
|
|
822
|
+
unavailableReason: z.ZodOptional<z.ZodEnum<{
|
|
823
|
+
AiCapabilityNotIncluded: "AiCapabilityNotIncluded";
|
|
824
|
+
AiDisabled: "AiDisabled";
|
|
825
|
+
AiAccessUnavailable: "AiAccessUnavailable";
|
|
826
|
+
}>>;
|
|
819
827
|
}, z.core.$strict>;
|
|
820
828
|
/**
|
|
821
829
|
* The Html5Asset renders full HTML5/CSS3/JS.
|
|
@@ -1514,6 +1522,8 @@ export declare const generationmodellistresponseGenerationModelListResponseSchem
|
|
|
1514
1522
|
video: "video";
|
|
1515
1523
|
audio: "audio";
|
|
1516
1524
|
}>;
|
|
1525
|
+
name: z.ZodOptional<z.ZodString>;
|
|
1526
|
+
description: z.ZodOptional<z.ZodString>;
|
|
1517
1527
|
pricing: z.ZodOptional<z.ZodObject<{
|
|
1518
1528
|
credits: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
|
|
1519
1529
|
tieredBy: z.ZodOptional<z.ZodObject<{
|
|
@@ -1536,6 +1546,12 @@ export declare const generationmodellistresponseGenerationModelListResponseSchem
|
|
|
1536
1546
|
effectiveFrom: z.ZodString;
|
|
1537
1547
|
}, z.core.$strict>>;
|
|
1538
1548
|
options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
1549
|
+
available: z.ZodOptional<z.ZodBoolean>;
|
|
1550
|
+
unavailableReason: z.ZodOptional<z.ZodEnum<{
|
|
1551
|
+
AiCapabilityNotIncluded: "AiCapabilityNotIncluded";
|
|
1552
|
+
AiDisabled: "AiDisabled";
|
|
1553
|
+
AiAccessUnavailable: "AiAccessUnavailable";
|
|
1554
|
+
}>>;
|
|
1539
1555
|
}, z.core.$strict>>;
|
|
1540
1556
|
}, z.core.$strict>;
|
|
1541
1557
|
/**
|
|
@@ -60526,6 +60542,8 @@ export declare const getModelsResponse: z.ZodObject<{
|
|
|
60526
60542
|
video: "video";
|
|
60527
60543
|
audio: "audio";
|
|
60528
60544
|
}>;
|
|
60545
|
+
name: z.ZodOptional<z.ZodString>;
|
|
60546
|
+
description: z.ZodOptional<z.ZodString>;
|
|
60529
60547
|
pricing: z.ZodOptional<z.ZodObject<{
|
|
60530
60548
|
credits: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
|
|
60531
60549
|
tieredBy: z.ZodOptional<z.ZodObject<{
|
|
@@ -60548,6 +60566,12 @@ export declare const getModelsResponse: z.ZodObject<{
|
|
|
60548
60566
|
effectiveFrom: z.ZodString;
|
|
60549
60567
|
}, z.core.$strict>>;
|
|
60550
60568
|
options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
60569
|
+
available: z.ZodOptional<z.ZodBoolean>;
|
|
60570
|
+
unavailableReason: z.ZodOptional<z.ZodEnum<{
|
|
60571
|
+
AiCapabilityNotIncluded: "AiCapabilityNotIncluded";
|
|
60572
|
+
AiDisabled: "AiDisabled";
|
|
60573
|
+
AiAccessUnavailable: "AiAccessUnavailable";
|
|
60574
|
+
}>>;
|
|
60551
60575
|
}, z.core.$strict>>;
|
|
60552
60576
|
}, z.core.$strict>;
|
|
60553
60577
|
export declare const getModelRequest: z.ZodObject<{
|
|
@@ -60567,6 +60591,8 @@ export declare const getModelResponse: z.ZodObject<{
|
|
|
60567
60591
|
video: "video";
|
|
60568
60592
|
audio: "audio";
|
|
60569
60593
|
}>;
|
|
60594
|
+
name: z.ZodOptional<z.ZodString>;
|
|
60595
|
+
description: z.ZodOptional<z.ZodString>;
|
|
60570
60596
|
pricing: z.ZodOptional<z.ZodObject<{
|
|
60571
60597
|
credits: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
|
|
60572
60598
|
tieredBy: z.ZodOptional<z.ZodObject<{
|
|
@@ -60589,6 +60615,12 @@ export declare const getModelResponse: z.ZodObject<{
|
|
|
60589
60615
|
effectiveFrom: z.ZodString;
|
|
60590
60616
|
}, z.core.$strict>>;
|
|
60591
60617
|
options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
60618
|
+
available: z.ZodOptional<z.ZodBoolean>;
|
|
60619
|
+
unavailableReason: z.ZodOptional<z.ZodEnum<{
|
|
60620
|
+
AiCapabilityNotIncluded: "AiCapabilityNotIncluded";
|
|
60621
|
+
AiDisabled: "AiDisabled";
|
|
60622
|
+
AiAccessUnavailable: "AiAccessUnavailable";
|
|
60623
|
+
}>>;
|
|
60592
60624
|
}, z.core.$strict>;
|
|
60593
60625
|
export declare const deleteAssetRequest: z.ZodObject<{
|
|
60594
60626
|
body: z.ZodOptional<z.ZodNever>;
|
package/dist/zod/zod.gen.js
CHANGED
|
@@ -481,8 +481,16 @@ export const generationmodelGenerationModelSchema = z.object({
|
|
|
481
481
|
'video',
|
|
482
482
|
'audio'
|
|
483
483
|
]),
|
|
484
|
+
name: z.optional(z.string()),
|
|
485
|
+
description: z.optional(z.string()),
|
|
484
486
|
pricing: z.optional(generationmodelpricingGenerationModelPricingSchema),
|
|
485
|
-
options: z.optional(z.record(z.string(), z.unknown()))
|
|
487
|
+
options: z.optional(z.record(z.string(), z.unknown())),
|
|
488
|
+
available: z.optional(z.boolean()),
|
|
489
|
+
unavailableReason: z.optional(z.enum([
|
|
490
|
+
'AiCapabilityNotIncluded',
|
|
491
|
+
'AiDisabled',
|
|
492
|
+
'AiAccessUnavailable'
|
|
493
|
+
]))
|
|
486
494
|
}).strict();
|
|
487
495
|
/**
|
|
488
496
|
* The Html5Asset renders full HTML5/CSS3/JS.
|
package/dist/zod/zod.gen.ts
CHANGED
|
@@ -412,8 +412,16 @@ export const generationmodelGenerationModelSchema = z.object({
|
|
|
412
412
|
'video',
|
|
413
413
|
'audio'
|
|
414
414
|
]),
|
|
415
|
+
name: z.optional(z.string()),
|
|
416
|
+
description: z.optional(z.string()),
|
|
415
417
|
pricing: z.optional(generationmodelpricingGenerationModelPricingSchema),
|
|
416
|
-
options: z.optional(z.record(z.string(), z.unknown()))
|
|
418
|
+
options: z.optional(z.record(z.string(), z.unknown())),
|
|
419
|
+
available: z.optional(z.boolean()),
|
|
420
|
+
unavailableReason: z.optional(z.enum([
|
|
421
|
+
'AiCapabilityNotIncluded',
|
|
422
|
+
'AiDisabled',
|
|
423
|
+
'AiAccessUnavailable'
|
|
424
|
+
]))
|
|
417
425
|
}).strict();
|
|
418
426
|
|
|
419
427
|
/**
|