@shotstack/schemas 1.17.0 → 1.18.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.
package/dist/schema.d.ts CHANGED
@@ -246,6 +246,71 @@ export interface paths {
246
246
  patch?: never;
247
247
  trace?: never;
248
248
  };
249
+ "/models": {
250
+ parameters: {
251
+ query?: {
252
+ /**
253
+ * @description Set to `options` to include each model's option schema in the list. Omitted by default to keep the response small.
254
+ * @example options
255
+ */
256
+ expand?: "options";
257
+ };
258
+ header?: never;
259
+ path?: never;
260
+ cookie?: never;
261
+ };
262
+ /**
263
+ * List Generation Models
264
+ * @description List the generation models available for `prompt`-bearing image, video and audio
265
+ * assets, with the options each accepts and what it costs in credits.
266
+ *
267
+ * Use this to populate a model picker and render its option fields, rather than
268
+ * hard coding a model list. A newly launched model appears here without any change
269
+ * on your side. Each entry carries the asset type it generates, so filter the list
270
+ * client side when a picker only needs one kind.
271
+ *
272
+ * Option schemas are omitted by default. Request them with `expand=options`.
273
+ *
274
+ * **Base URL:** <a href="#">https://api.shotstack.io/edit/{version}</a>
275
+ */
276
+ get: operations["getModels"];
277
+ put?: never;
278
+ post?: never;
279
+ delete?: never;
280
+ options?: never;
281
+ head?: never;
282
+ patch?: never;
283
+ trace?: never;
284
+ };
285
+ "/models/{id}": {
286
+ parameters: {
287
+ query?: never;
288
+ header?: never;
289
+ path: {
290
+ /**
291
+ * @description The model identifier, as returned by the list endpoint.
292
+ * @example seedance-2.0
293
+ */
294
+ id: string;
295
+ };
296
+ cookie?: never;
297
+ };
298
+ /**
299
+ * Get Generation Model
300
+ * @description Get one generation model, including the JSON Schema for the options it accepts and
301
+ * what it costs in credits.
302
+ *
303
+ * **Base URL:** <a href="#">https://api.shotstack.io/edit/{version}</a>
304
+ */
305
+ get: operations["getModel"];
306
+ put?: never;
307
+ post?: never;
308
+ delete?: never;
309
+ options?: never;
310
+ head?: never;
311
+ patch?: never;
312
+ trace?: never;
313
+ };
249
314
  "/assets/{id}": {
250
315
  parameters: {
251
316
  query?: never;
@@ -619,8 +684,9 @@ export interface components {
619
684
  *
620
685
  * - **Source URL:** set `src` to the URL of an mp4 (or compatible) video file.
621
686
  * - **Generated:** set `prompt` to describe the motion. Choose a generator
622
- * with `model` and configure it with model-specific `options` (including a
623
- * starting image for image-to-video). The generated `src` is filled in
687
+ * with `model` and configure it with model-specific `options`. Models that
688
+ * animate a starting image take it as `options.inputSrc`; the default model
689
+ * generates from the prompt alone. The generated `src` is filled in
624
690
  * automatically.
625
691
  * - **Both:** `src` acts as a preview placeholder while `prompt` drives
626
692
  * generation — the video is regenerated from the prompt at render time.
@@ -638,7 +704,7 @@ export interface components {
638
704
  */
639
705
  src?: string;
640
706
  /**
641
- * @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 (including a starting image for image-to-video).
707
+ * @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.
642
708
  * @example Slowly zoom out and orbit left around the object.
643
709
  */
644
710
  prompt?: string;
@@ -1062,7 +1128,10 @@ export interface components {
1062
1128
  trim?: number;
1063
1129
  };
1064
1130
  /**
1065
- * @description The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will
1131
+ * @deprecated
1132
+ * @description **Notice: The CaptionAsset is deprecated, use the [RichCaptionAsset](#tocs_richcaptionasset) instead.**
1133
+ *
1134
+ * The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will
1066
1135
  * be read and burnt to the video.
1067
1136
  *
1068
1137
  * Captions can be applied independently from a video or audio file for greater
@@ -1325,9 +1394,10 @@ export interface components {
1325
1394
  /**
1326
1395
  * @deprecated
1327
1396
  * @description **Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)
1328
- * with `prompt` and `inputSrc` instead.** This type continues to function and is
1329
- * internally rewritten to VideoAsset; no behaviour change for existing
1330
- * integrations.
1397
+ * with `prompt`, a `model` that accepts a starting image, and that image in
1398
+ * `options.inputSrc` — for example `shotstack-itv-mini`.** This type continues to
1399
+ * function and is internally rewritten to VideoAsset; no behaviour change for
1400
+ * existing integrations.
1331
1401
  *
1332
1402
  * The ImageToVideoAsset lets you create a video from an image and a text prompt.
1333
1403
  */
@@ -2953,6 +3023,7 @@ export interface components {
2953
3023
  * <li>`fetching` - assets are being fetched</li>
2954
3024
  * <li>`preprocessing` - video assets are being processed for compatibility</li>
2955
3025
  * <li>`rendering` - the asset is being rendered</li>
3026
+ * <li>`generating` - AI/media generation is in progress</li>
2956
3027
  * <li>`saving` - the final asset is being saved to storage</li>
2957
3028
  * <li>`done` - the asset is ready to be downloaded</li>
2958
3029
  * <li>`failed` - there was an error rendering the asset</li>
@@ -2960,7 +3031,7 @@ export interface components {
2960
3031
  * @example done
2961
3032
  * @enum {string}
2962
3033
  */
2963
- status: "queued" | "fetching" | "preprocessing" | "rendering" | "saving" | "done" | "failed";
3034
+ status: "queued" | "fetching" | "preprocessing" | "rendering" | "generating" | "saving" | "done" | "failed";
2964
3035
  /**
2965
3036
  * @description An error message, only displayed if an error occurred.
2966
3037
  * @example
@@ -3912,6 +3983,121 @@ export interface operations {
3912
3983
  };
3913
3984
  };
3914
3985
  };
3986
+ getModels: {
3987
+ parameters: {
3988
+ query?: {
3989
+ /**
3990
+ * @description Set to `options` to include each model's option schema in the list. Omitted by default to keep the response small.
3991
+ * @example options
3992
+ */
3993
+ expand?: "options";
3994
+ };
3995
+ header?: never;
3996
+ path?: never;
3997
+ cookie?: never;
3998
+ };
3999
+ requestBody?: never;
4000
+ responses: {
4001
+ /** @description The available generation models. */
4002
+ 200: {
4003
+ headers: {
4004
+ [name: string]: unknown;
4005
+ };
4006
+ content: {
4007
+ "application/json": {
4008
+ /** @description The available models. */
4009
+ models: paths["/models/{id}"]["get"]["responses"]["200"]["content"]["application/json"]["schema"][];
4010
+ };
4011
+ };
4012
+ };
4013
+ };
4014
+ };
4015
+ getModel: {
4016
+ parameters: {
4017
+ query?: never;
4018
+ header?: never;
4019
+ path: {
4020
+ /**
4021
+ * @description The model identifier, as returned by the list endpoint.
4022
+ * @example seedance-2.0
4023
+ */
4024
+ id: string;
4025
+ };
4026
+ cookie?: never;
4027
+ };
4028
+ requestBody?: never;
4029
+ responses: {
4030
+ /** @description The generation model, with its option schema. */
4031
+ 200: {
4032
+ headers: {
4033
+ [name: string]: unknown;
4034
+ };
4035
+ content: {
4036
+ "application/json": {
4037
+ /**
4038
+ * @description The identifier to set as the asset `model`. Carries no provider name, so routing can change without a public rename.
4039
+ * @example seedance-2.0
4040
+ */
4041
+ model: string;
4042
+ /**
4043
+ * @description The asset type this model generates.
4044
+ * @example video
4045
+ * @enum {string}
4046
+ */
4047
+ type: "image" | "video" | "audio";
4048
+ /** @description What one generation with this model costs. */
4049
+ pricing?: {
4050
+ /**
4051
+ * @description What one unit is. `render` means the whole generation counts as one unit, whatever its size.
4052
+ * @example second
4053
+ * @enum {string}
4054
+ */
4055
+ unit: "render" | "second" | "minute" | "thousandCharacters";
4056
+ /**
4057
+ * @description Credits per unit. A number when the rate is flat, or an object keyed by the values of the options named in `tieredBy`.
4058
+ * @example {
4059
+ * "480p": 0.9375,
4060
+ * "720p": 1.8962,
4061
+ * "1080p": 4.2625
4062
+ * }
4063
+ */
4064
+ credits: number | {
4065
+ [key: string]: unknown;
4066
+ };
4067
+ /**
4068
+ * @description The options whose values select the rate, outermost first. Absent when `credits` is a single number.
4069
+ * @example [
4070
+ * "resolution"
4071
+ * ]
4072
+ */
4073
+ tieredBy?: string[];
4074
+ /**
4075
+ * @description The fewest units a generation is charged for, when a model has a minimum charge.
4076
+ * @example 0.1
4077
+ */
4078
+ minUnits?: number;
4079
+ /**
4080
+ * @description The date this rate took effect, or `legacy` for a rate that predates dated pricing.
4081
+ * @example 2026-08-13
4082
+ */
4083
+ effectiveFrom: string;
4084
+ };
4085
+ /** @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. */
4086
+ options?: {
4087
+ [key: string]: unknown;
4088
+ };
4089
+ };
4090
+ };
4091
+ };
4092
+ /** @description No model exists with that identifier. */
4093
+ 404: {
4094
+ headers: {
4095
+ [name: string]: unknown;
4096
+ };
4097
+ content?: never;
4098
+ };
4099
+ };
4100
+ };
3915
4101
  getAsset: {
3916
4102
  parameters: {
3917
4103
  query?: never;
@@ -1,12 +1,13 @@
1
1
  "use strict";
2
2
  // This file is auto-generated by @hey-api/openapi-ts
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.shotstackDestinationSchema = exports.shotstackDestinationShotstackDestinationSchema = exports.s3DestinationSchema = exports.s3DestinationS3DestinationSchema = exports.s3DestinationOptionsSchema = exports.s3DestinationOptionsS3DestinationOptionsSchema = exports.muxDestinationSchema = exports.muxDestinationMuxDestinationSchema = exports.muxDestinationOptionsSchema = exports.muxDestinationOptionsMuxDestinationOptionsSchema = exports.googleDriveDestinationSchema = exports.googleDriveDestinationGoogleDriveDestinationSchema = exports.googleDriveDestinationOptionsSchema = exports.googleDriveDestinationOptionsGoogleDriveDestinationOptionsSchema = exports.googleCloudStorageDestinationSchema = exports.googleCloudStorageDestinationGoogleCloudStorageDestinationSchema = exports.googleCloudStorageDestinationOptionsSchema = exports.googleCloudStorageDestinationOptionsGoogleCloudStorageDestinationOptionsSchema = exports.azureBlobStorageDestinationAzureBlobStorageDestinationSchema = exports.azureBlobStorageDestinationOptionsAzureBlobStorageDestinationOptionsSchema = exports.akamaiNetStorageDestinationAkamaiNetStorageDestinationSchema = exports.akamaiNetStorageDestinationOptionsAkamaiNetStorageDestinationOptionsSchema = exports.cropSchema = exports.cropCropSchema = exports.chromaKeySchema = exports.chromakeyChromaKeySchema = exports.captionAssetSchema = exports.captionassetCaptionAssetSchema = exports.captionMarginSchema = exports.captionpropertiesCaptionMarginSchema = exports.captionFontSchema = exports.captionpropertiesCaptionFontSchema = exports.captionBackgroundSchema = exports.captionpropertiesCaptionBackgroundSchema = exports.uploadRootSchema = exports.templatesrenderRootSchema = exports.templatesidRootSchema = exports.templatesRootSchema = exports.sourcesidRootSchema = exports.sourcesRootSchema = exports.renderidRootSchema = exports.renderRootSchema = exports.probeRootSchema = exports.generateidRootSchema = exports.generateRootSchema = exports.assetsrenderidRootSchema = exports.assetsidRootSchema = exports.assetsRootSchema = exports.sourceRootSchema = exports.editRootSchema = void 0;
5
- exports.lumaAssetSchema = exports.lumaassetLumaAssetSchema = exports.transcriptionSchema = exports.transcriptionTranscriptionSchema = exports.speedSchema = exports.speedSpeedSchema = exports.uploadResponseSchema = exports.uploadresponseUploadResponseSchema = exports.uploadResponseDataSchema = exports.uploadresponsedataUploadResponseDataSchema = exports.uploadResponseAttributesSchema = exports.uploadresponseattributesUploadResponseAttributesSchema = exports.queuedSourceResponseSchema = exports.queuedsourceresponseQueuedSourceResponseSchema = exports.queuedSourceResponseDataSchema = exports.queuedsourceresponsedataQueuedSourceResponseDataSchema = exports.ingestErrorResponseSchema = exports.ingesterrorresponseIngestErrorResponseSchema = exports.ingestErrorResponseDataSchema = exports.ingesterrorresponsedataIngestErrorResponseDataSchema = exports.enhancementsSchema = exports.enhancementsEnhancementsSchema = exports.audioEnhancementSchema = exports.audioEnhancementAudioEnhancementSchema = exports.dolbyEnhancementSchema = exports.dolbyEnhancementDolbyEnhancementSchema = exports.dolbyEnhancementOptionsSchema = exports.dolbyEnhancementOptionsDolbyEnhancementOptionsSchema = exports.imageToVideoAssetSchema = exports.imagetovideoassetImageToVideoAssetSchema = exports.imageAssetSchema = exports.imageassetImageAssetSchema = exports.htmlAssetSchema = exports.htmlassetHtmlAssetSchema = exports.html5AssetSchema = exports.html5AssetHtml5AssetSchema = exports.fontSchema = exports.fontFontSchema = exports.flipTransformationSchema = exports.fliptransformationFlipTransformationSchema = exports.destinationsSchema = exports.destinationsDestinationsSchema = exports.vimeoDestinationSchema = exports.vimeoDestinationVimeoDestinationSchema = exports.vimeoDestinationOptionsSchema = exports.vimeoDestinationOptionsVimeoDestinationOptionsSchema = exports.vimeoDestinationPrivacyOptionsSchema = exports.vimeoDestinationPrivacyOptionsVimeoDestinationPrivacyOptionsSchema = exports.tiktokDestinationTiktokDestinationSchema = exports.tiktokDestinationOptionsTiktokDestinationOptionsSchema = void 0;
6
- exports.richtextpropertiesRichTextStrokeSchema = exports.richTextShadowSchema = exports.richtextpropertiesRichTextShadowSchema = exports.richtextpropertiesRichTextPaddingSchema = exports.richcaptionpropertiesRichCaptionStyleSchema = exports.richTextGradientSchema = exports.richtextpropertiesRichTextGradientSchema = exports.richtextpropertiesRichTextBorderSchema = exports.richTextBackgroundSchema = exports.richtextpropertiesRichTextBackgroundSchema = exports.richTextAnimationSchema = exports.richtextpropertiesRichTextAnimationSchema = exports.richTextAlignmentSchema = exports.richtextpropertiesRichTextAlignmentSchema = exports.richcaptionpropertiesRichCaptionFontSchema = exports.richCaptionAnimationSchema = exports.richcaptionpropertiesRichCaptionAnimationSchema = exports.richCaptionActiveFontSchema = exports.richcaptionpropertiesRichCaptionActiveFontSchema = exports.templateResponseSchema = exports.templateresponseTemplateResponseSchema = exports.templateResponseDataSchema = exports.templateresponsedataTemplateResponseDataSchema = exports.templateListResponseSchema = exports.templatelistresponseTemplateListResponseSchema = exports.templateListResponseDataSchema = exports.templatelistresponsedataTemplateListResponseDataSchema = exports.templateListResponseItemSchema = exports.templatelistresponseitemTemplateListResponseItemSchema = exports.queuedResponseSchema = exports.queuedresponseQueuedResponseSchema = exports.queuedResponseDataSchema = exports.queuedresponsedataQueuedResponseDataSchema = exports.probeResponseSchema = exports.proberesponseProbeResponseSchema = exports.generationresponseGenerationResponseSchema = exports.assetResponseSchema = exports.assetresponseAssetResponseSchema = exports.assetRenderResponseSchema = exports.assetrenderresponseAssetRenderResponseSchema = exports.assetResponseDataSchema = exports.assetresponsedataAssetResponseDataSchema = exports.assetResponseAttributesSchema = exports.assetresponseattributesAssetResponseAttributesSchema = exports.rangeSchema = exports.rangeRangeSchema = exports.posterSchema = exports.posterPosterSchema = exports.mergeFieldSchema = exports.mergefieldMergeFieldSchema = void 0;
7
- exports.textpropertiesTextAnimationSchema = exports.textAlignmentSchema = exports.textpropertiesTextAlignmentSchema = exports.templateRenderSchema = exports.templaterenderTemplateRenderSchema = exports.svgAssetSchema = exports.svgassetSvgAssetSchema = exports.soundtrackSchema = exports.soundtrackSoundtrackSchema = exports.sourceSchema = exports.sourceSourceSchema = exports.sourceResponseSchema = exports.sourceresponseSourceResponseSchema = exports.sourceListResponseSchema = exports.sourcelistresponseSourceListResponseSchema = exports.sourceResponseDataSchema = exports.sourceresponsedataSourceResponseDataSchema = exports.sourceResponseAttributesSchema = exports.sourceresponseattributesSourceResponseAttributesSchema = exports.outputsResponseSchema = exports.outputsresponseOutputsResponseSchema = exports.renditionResponseAttributesSchema = exports.renditionresponseattributesRenditionResponseAttributesSchema = exports.outputsSchema = exports.outputsOutputsSchema = exports.renditionSchema = exports.renditionRenditionSchema = exports.sizeSchema = exports.sizeSizeSchema = exports.shapeAssetSchema = exports.shapeassetShapeAssetSchema = exports.transferSchema = exports.transferTransferSchema = exports.transferResponseSchema = exports.transferresponseTransferResponseSchema = exports.transferResponseDataSchema = exports.transferresponsedataTransferResponseDataSchema = exports.transferResponseAttributesSchema = exports.transferresponseattributesTransferResponseAttributesSchema = exports.richTextAssetSchema = exports.richtextassetRichTextAssetSchema = exports.richTextStyleSchema = exports.richtextpropertiesRichTextStyleSchema = exports.richTextFontSchema = exports.richtextpropertiesRichTextFontSchema = exports.richCaptionAssetSchema = exports.richcaptionassetRichCaptionAssetSchema = exports.richCaptionActiveSchema = exports.richcaptionpropertiesRichCaptionActiveSchema = exports.richTextStrokeSchema = void 0;
8
- exports.templatedataresponseTemplateDataResponseSchema = exports.templateDataResponseDataSchema = exports.templatedataresponsedataTemplateDataResponseDataSchema = exports.renderResponseSchema = exports.renderresponseRenderResponseSchema = exports.renderResponseDataSchema = exports.renderresponsedataRenderResponseDataSchema = exports.editSchema = exports.editEditSchema = exports.timelineSchema = exports.timelineTimelineSchema = exports.trackSchema = exports.trackTrackSchema = exports.clipSchema = exports.clipClipSchema = exports.assetSchema = exports.assetAssetSchema = exports.videoAssetSchema = exports.videoassetVideoAssetSchema = exports.transformationSchema = exports.transformationTransformationSchema = exports.titleAssetSchema = exports.titleassetTitleAssetSchema = exports.textToSpeechAssetSchema = exports.texttospeechassetTextToSpeechAssetSchema = exports.skewTransformationSchema = exports.skewtransformationSkewTransformationSchema = exports.rotateTransformationSchema = exports.rotatetransformationRotateTransformationSchema = exports.offsetSchema = exports.offsetOffsetSchema = exports.audioAssetSchema = exports.audioassetAudioAssetSchema = exports.tweenSchema = exports.tweenTweenSchema = exports.transitionSchema = exports.transitionTransitionSchema = exports.outputSchema = exports.outputOutputSchema = exports.thumbnailSchema = exports.thumbnailThumbnailSchema = exports.textToImageAssetSchema = exports.texttoimageassetTextToImageAssetSchema = exports.textAssetSchema = exports.textassetTextAssetSchema = exports.textpropertiesTextStrokeSchema = exports.textFontSchema = exports.textpropertiesTextFontSchema = exports.textBackgroundSchema = exports.textpropertiesTextBackgroundSchema = void 0;
9
- exports.getUploadSignedUrlResponse = exports.getUploadSignedUrlRequest = exports.getSourceResponse = exports.getSourceRequest = exports.deleteSourceResponse = exports.deleteSourceRequest = exports.postSourceResponse = exports.postSourceRequest = exports.getSourcesResponse = exports.getSourcesRequest = exports.postServeAssetResponse = exports.postServeAssetRequest = exports.getAssetByRenderIdResponse = exports.getAssetByRenderIdRequest = exports.getAssetResponse = exports.getAssetRequest = exports.deleteAssetResponse = exports.deleteAssetRequest = exports.getGenerateResponse = exports.getGenerateRequest = exports.postGenerateResponse = exports.postGenerateRequest = exports.probeResponse = exports.probeRequest = exports.postTemplateRenderResponse = exports.postTemplateRenderRequest = exports.putTemplateResponse = exports.putTemplateRequest = exports.getTemplateResponse = exports.getTemplateRequest = exports.deleteTemplateResponse = exports.deleteTemplateRequest = exports.postTemplateResponse = exports.postTemplateRequest = exports.getTemplatesResponse = exports.getTemplatesRequest = exports.getRenderResponse = exports.getRenderRequest = exports.postRenderResponse = exports.postRenderRequest = exports.templateSchema = exports.templateTemplateSchema = exports.templateDataResponseSchema = void 0;
4
+ exports.s3DestinationSchema = exports.s3DestinationS3DestinationSchema = exports.s3DestinationOptionsSchema = exports.s3DestinationOptionsS3DestinationOptionsSchema = exports.muxDestinationSchema = exports.muxDestinationMuxDestinationSchema = exports.muxDestinationOptionsSchema = exports.muxDestinationOptionsMuxDestinationOptionsSchema = exports.googleDriveDestinationSchema = exports.googleDriveDestinationGoogleDriveDestinationSchema = exports.googleDriveDestinationOptionsSchema = exports.googleDriveDestinationOptionsGoogleDriveDestinationOptionsSchema = exports.googleCloudStorageDestinationSchema = exports.googleCloudStorageDestinationGoogleCloudStorageDestinationSchema = exports.googleCloudStorageDestinationOptionsSchema = exports.googleCloudStorageDestinationOptionsGoogleCloudStorageDestinationOptionsSchema = exports.azureBlobStorageDestinationAzureBlobStorageDestinationSchema = exports.azureBlobStorageDestinationOptionsAzureBlobStorageDestinationOptionsSchema = exports.akamaiNetStorageDestinationAkamaiNetStorageDestinationSchema = exports.akamaiNetStorageDestinationOptionsAkamaiNetStorageDestinationOptionsSchema = exports.cropSchema = exports.cropCropSchema = exports.chromaKeySchema = exports.chromakeyChromaKeySchema = exports.captionAssetSchema = exports.captionassetCaptionAssetSchema = exports.captionMarginSchema = exports.captionpropertiesCaptionMarginSchema = exports.captionFontSchema = exports.captionpropertiesCaptionFontSchema = exports.captionBackgroundSchema = exports.captionpropertiesCaptionBackgroundSchema = exports.uploadRootSchema = exports.templatesrenderRootSchema = exports.templatesidRootSchema = exports.templatesRootSchema = exports.sourcesidRootSchema = exports.sourcesRootSchema = exports.renderidRootSchema = exports.renderRootSchema = exports.probeRootSchema = exports.modelsidRootSchema = exports.modelsRootSchema = exports.generateidRootSchema = exports.generateRootSchema = exports.assetsrenderidRootSchema = exports.assetsidRootSchema = exports.assetsRootSchema = exports.sourceRootSchema = exports.editRootSchema = void 0;
5
+ exports.speedSchema = exports.speedSpeedSchema = exports.uploadResponseSchema = exports.uploadresponseUploadResponseSchema = exports.uploadResponseDataSchema = exports.uploadresponsedataUploadResponseDataSchema = exports.uploadResponseAttributesSchema = exports.uploadresponseattributesUploadResponseAttributesSchema = exports.queuedSourceResponseSchema = exports.queuedsourceresponseQueuedSourceResponseSchema = exports.queuedSourceResponseDataSchema = exports.queuedsourceresponsedataQueuedSourceResponseDataSchema = exports.ingestErrorResponseSchema = exports.ingesterrorresponseIngestErrorResponseSchema = exports.ingestErrorResponseDataSchema = exports.ingesterrorresponsedataIngestErrorResponseDataSchema = exports.enhancementsSchema = exports.enhancementsEnhancementsSchema = exports.audioEnhancementSchema = exports.audioEnhancementAudioEnhancementSchema = exports.dolbyEnhancementSchema = exports.dolbyEnhancementDolbyEnhancementSchema = exports.dolbyEnhancementOptionsSchema = exports.dolbyEnhancementOptionsDolbyEnhancementOptionsSchema = exports.imageToVideoAssetSchema = exports.imagetovideoassetImageToVideoAssetSchema = exports.imageAssetSchema = exports.imageassetImageAssetSchema = exports.htmlAssetSchema = exports.htmlassetHtmlAssetSchema = exports.html5AssetSchema = exports.html5AssetHtml5AssetSchema = exports.generationmodelGenerationModelSchema = exports.generationmodelpricingGenerationModelPricingSchema = exports.fontSchema = exports.fontFontSchema = exports.flipTransformationSchema = exports.fliptransformationFlipTransformationSchema = exports.destinationsSchema = exports.destinationsDestinationsSchema = exports.vimeoDestinationSchema = exports.vimeoDestinationVimeoDestinationSchema = exports.vimeoDestinationOptionsSchema = exports.vimeoDestinationOptionsVimeoDestinationOptionsSchema = exports.vimeoDestinationPrivacyOptionsSchema = exports.vimeoDestinationPrivacyOptionsVimeoDestinationPrivacyOptionsSchema = exports.tiktokDestinationTiktokDestinationSchema = exports.tiktokDestinationOptionsTiktokDestinationOptionsSchema = exports.shotstackDestinationSchema = exports.shotstackDestinationShotstackDestinationSchema = void 0;
6
+ exports.richTextGradientSchema = exports.richtextpropertiesRichTextGradientSchema = exports.richtextpropertiesRichTextBorderSchema = exports.richTextBackgroundSchema = exports.richtextpropertiesRichTextBackgroundSchema = exports.richTextAnimationSchema = exports.richtextpropertiesRichTextAnimationSchema = exports.richTextAlignmentSchema = exports.richtextpropertiesRichTextAlignmentSchema = exports.richcaptionpropertiesRichCaptionFontSchema = exports.richCaptionAnimationSchema = exports.richcaptionpropertiesRichCaptionAnimationSchema = exports.richCaptionActiveFontSchema = exports.richcaptionpropertiesRichCaptionActiveFontSchema = exports.templateResponseSchema = exports.templateresponseTemplateResponseSchema = exports.templateResponseDataSchema = exports.templateresponsedataTemplateResponseDataSchema = exports.templateListResponseSchema = exports.templatelistresponseTemplateListResponseSchema = exports.templateListResponseDataSchema = exports.templatelistresponsedataTemplateListResponseDataSchema = exports.templateListResponseItemSchema = exports.templatelistresponseitemTemplateListResponseItemSchema = exports.queuedResponseSchema = exports.queuedresponseQueuedResponseSchema = exports.queuedResponseDataSchema = exports.queuedresponsedataQueuedResponseDataSchema = exports.probeResponseSchema = exports.proberesponseProbeResponseSchema = exports.generationresponseGenerationResponseSchema = exports.generationmodellistresponseGenerationModelListResponseSchema = exports.assetResponseSchema = exports.assetresponseAssetResponseSchema = exports.assetRenderResponseSchema = exports.assetrenderresponseAssetRenderResponseSchema = exports.assetResponseDataSchema = exports.assetresponsedataAssetResponseDataSchema = exports.assetResponseAttributesSchema = exports.assetresponseattributesAssetResponseAttributesSchema = exports.rangeSchema = exports.rangeRangeSchema = exports.posterSchema = exports.posterPosterSchema = exports.mergeFieldSchema = exports.mergefieldMergeFieldSchema = exports.lumaAssetSchema = exports.lumaassetLumaAssetSchema = exports.transcriptionSchema = exports.transcriptionTranscriptionSchema = void 0;
7
+ exports.svgAssetSchema = exports.svgassetSvgAssetSchema = exports.soundtrackSchema = exports.soundtrackSoundtrackSchema = exports.sourceSchema = exports.sourceSourceSchema = exports.sourceResponseSchema = exports.sourceresponseSourceResponseSchema = exports.sourceListResponseSchema = exports.sourcelistresponseSourceListResponseSchema = exports.sourceResponseDataSchema = exports.sourceresponsedataSourceResponseDataSchema = exports.sourceResponseAttributesSchema = exports.sourceresponseattributesSourceResponseAttributesSchema = exports.outputsResponseSchema = exports.outputsresponseOutputsResponseSchema = exports.renditionResponseAttributesSchema = exports.renditionresponseattributesRenditionResponseAttributesSchema = exports.outputsSchema = exports.outputsOutputsSchema = exports.renditionSchema = exports.renditionRenditionSchema = exports.sizeSchema = exports.sizeSizeSchema = exports.shapeAssetSchema = exports.shapeassetShapeAssetSchema = exports.transferSchema = exports.transferTransferSchema = exports.transferResponseSchema = exports.transferresponseTransferResponseSchema = exports.transferResponseDataSchema = exports.transferresponsedataTransferResponseDataSchema = exports.transferResponseAttributesSchema = exports.transferresponseattributesTransferResponseAttributesSchema = exports.richTextAssetSchema = exports.richtextassetRichTextAssetSchema = exports.richTextStyleSchema = exports.richtextpropertiesRichTextStyleSchema = exports.richTextFontSchema = exports.richtextpropertiesRichTextFontSchema = exports.richCaptionAssetSchema = exports.richcaptionassetRichCaptionAssetSchema = exports.richCaptionActiveSchema = exports.richcaptionpropertiesRichCaptionActiveSchema = exports.richTextStrokeSchema = exports.richtextpropertiesRichTextStrokeSchema = exports.richTextShadowSchema = exports.richtextpropertiesRichTextShadowSchema = exports.richtextpropertiesRichTextPaddingSchema = exports.richcaptionpropertiesRichCaptionStyleSchema = void 0;
8
+ exports.renderResponseDataSchema = exports.renderresponsedataRenderResponseDataSchema = exports.editSchema = exports.editEditSchema = exports.timelineSchema = exports.timelineTimelineSchema = exports.trackSchema = exports.trackTrackSchema = exports.clipSchema = exports.clipClipSchema = exports.assetSchema = exports.assetAssetSchema = exports.videoAssetSchema = exports.videoassetVideoAssetSchema = exports.transformationSchema = exports.transformationTransformationSchema = exports.titleAssetSchema = exports.titleassetTitleAssetSchema = exports.textToSpeechAssetSchema = exports.texttospeechassetTextToSpeechAssetSchema = exports.skewTransformationSchema = exports.skewtransformationSkewTransformationSchema = exports.rotateTransformationSchema = exports.rotatetransformationRotateTransformationSchema = exports.offsetSchema = exports.offsetOffsetSchema = exports.audioAssetSchema = exports.audioassetAudioAssetSchema = exports.tweenSchema = exports.tweenTweenSchema = exports.transitionSchema = exports.transitionTransitionSchema = exports.outputSchema = exports.outputOutputSchema = exports.thumbnailSchema = exports.thumbnailThumbnailSchema = exports.textToImageAssetSchema = exports.texttoimageassetTextToImageAssetSchema = exports.textAssetSchema = exports.textassetTextAssetSchema = exports.textpropertiesTextStrokeSchema = exports.textFontSchema = exports.textpropertiesTextFontSchema = exports.textBackgroundSchema = exports.textpropertiesTextBackgroundSchema = exports.textpropertiesTextAnimationSchema = exports.textAlignmentSchema = exports.textpropertiesTextAlignmentSchema = exports.templateRenderSchema = exports.templaterenderTemplateRenderSchema = void 0;
9
+ exports.getSourceResponse = exports.getSourceRequest = exports.deleteSourceResponse = exports.deleteSourceRequest = exports.postSourceResponse = exports.postSourceRequest = exports.getSourcesResponse = exports.getSourcesRequest = exports.postServeAssetResponse = exports.postServeAssetRequest = exports.getAssetByRenderIdResponse = exports.getAssetByRenderIdRequest = exports.getAssetResponse = exports.getAssetRequest = exports.deleteAssetResponse = exports.deleteAssetRequest = exports.getModelResponse = exports.getModelRequest = exports.getModelsResponse = exports.getModelsRequest = exports.getGenerateResponse = exports.getGenerateRequest = exports.postGenerateResponse = exports.postGenerateRequest = exports.probeResponse = exports.probeRequest = exports.postTemplateRenderResponse = exports.postTemplateRenderRequest = exports.putTemplateResponse = exports.putTemplateRequest = exports.getTemplateResponse = exports.getTemplateRequest = exports.deleteTemplateResponse = exports.deleteTemplateRequest = exports.postTemplateResponse = exports.postTemplateRequest = exports.getTemplatesResponse = exports.getTemplatesRequest = exports.getRenderResponse = exports.getRenderRequest = exports.postRenderResponse = exports.postRenderRequest = exports.templateSchema = exports.templateTemplateSchema = exports.templateDataResponseSchema = exports.templatedataresponseTemplateDataResponseSchema = exports.templateDataResponseDataSchema = exports.templatedataresponsedataTemplateDataResponseDataSchema = exports.renderResponseSchema = exports.renderresponseRenderResponseSchema = void 0;
10
+ exports.getUploadSignedUrlResponse = exports.getUploadSignedUrlRequest = void 0;
10
11
  const zod_1 = require("zod");
11
12
  exports.editRootSchema = zod_1.z.unknown();
12
13
  exports.sourceRootSchema = zod_1.z.unknown();
@@ -15,6 +16,8 @@ exports.assetsidRootSchema = zod_1.z.unknown();
15
16
  exports.assetsrenderidRootSchema = zod_1.z.unknown();
16
17
  exports.generateRootSchema = zod_1.z.unknown();
17
18
  exports.generateidRootSchema = zod_1.z.unknown();
19
+ exports.modelsRootSchema = zod_1.z.unknown();
20
+ exports.modelsidRootSchema = zod_1.z.unknown();
18
21
  exports.probeRootSchema = zod_1.z.unknown();
19
22
  exports.renderRootSchema = zod_1.z.unknown();
20
23
  exports.renderidRootSchema = zod_1.z.unknown();
@@ -117,6 +120,8 @@ exports.captionpropertiesCaptionMarginSchema = zod_1.z.object({
117
120
  }).strict();
118
121
  exports.captionMarginSchema = exports.captionpropertiesCaptionMarginSchema;
119
122
  /**
123
+ * **Notice: The CaptionAsset is deprecated, use the [RichCaptionAsset](#tocs_richcaptionasset) instead.**
124
+ *
120
125
  * The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will
121
126
  * be read and burnt to the video.
122
127
  *
@@ -127,6 +132,8 @@ exports.captionMarginSchema = exports.captionpropertiesCaptionMarginSchema;
127
132
  * To sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with
128
133
  * matching start and end time.
129
134
  *
135
+ *
136
+ * @deprecated
130
137
  */
131
138
  exports.captionassetCaptionAssetSchema = zod_1.z.object({
132
139
  type: zod_1.z.enum(['caption']),
@@ -421,6 +428,49 @@ exports.fontFontSchema = zod_1.z.object({
421
428
  src: zod_1.z.string()
422
429
  }).strict();
423
430
  exports.fontSchema = exports.fontFontSchema;
431
+ /**
432
+ * What one generation costs, in credits. There is no formula to evaluate: multiply the rate by the number of units the generation consumes. Where a model charges differently per option value, `credits` is an object keyed by that value and `tieredBy` names the option that selects it.
433
+ */
434
+ exports.generationmodelpricingGenerationModelPricingSchema = zod_1.z.object({
435
+ unit: zod_1.z.enum([
436
+ 'render',
437
+ 'second',
438
+ 'minute',
439
+ 'thousandCharacters'
440
+ ]),
441
+ credits: zod_1.z.union([
442
+ zod_1.z.union([zod_1.z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
443
+ return undefined; if (Array.isArray(v))
444
+ return v; if (typeof v === 'string') {
445
+ if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v))
446
+ return v;
447
+ return Number(v);
448
+ } return v; }), zod_1.z.number()), zod_1.z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
449
+ zod_1.z.record(zod_1.z.string(), zod_1.z.unknown())
450
+ ]),
451
+ tieredBy: zod_1.z.optional(zod_1.z.array(zod_1.z.string())),
452
+ minUnits: zod_1.z.optional(zod_1.z.union([zod_1.z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
453
+ return undefined; if (Array.isArray(v))
454
+ return v; if (typeof v === 'string') {
455
+ if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v))
456
+ return v;
457
+ return Number(v);
458
+ } return v; }), zod_1.z.number()), zod_1.z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
459
+ effectiveFrom: zod_1.z.string()
460
+ }).strict();
461
+ /**
462
+ * 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.
463
+ */
464
+ exports.generationmodelGenerationModelSchema = zod_1.z.object({
465
+ model: zod_1.z.string(),
466
+ type: zod_1.z.enum([
467
+ 'image',
468
+ 'video',
469
+ 'audio'
470
+ ]),
471
+ pricing: zod_1.z.optional(exports.generationmodelpricingGenerationModelPricingSchema),
472
+ options: zod_1.z.optional(zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()))
473
+ }).strict();
424
474
  /**
425
475
  * The Html5Asset renders full HTML5/CSS3/JS.
426
476
  *
@@ -509,9 +559,10 @@ exports.imageassetImageAssetSchema = zod_1.z.object({
509
559
  exports.imageAssetSchema = exports.imageassetImageAssetSchema;
510
560
  /**
511
561
  * **Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)
512
- * with `prompt` and `inputSrc` instead.** This type continues to function and is
513
- * internally rewritten to VideoAsset; no behaviour change for existing
514
- * integrations.
562
+ * with `prompt`, a `model` that accepts a starting image, and that image in
563
+ * `options.inputSrc` — for example `shotstack-itv-mini`.** This type continues to
564
+ * function and is internally rewritten to VideoAsset; no behaviour change for
565
+ * existing integrations.
515
566
  *
516
567
  * The ImageToVideoAsset lets you create a video from an image and a text prompt.
517
568
  *
@@ -759,6 +810,12 @@ exports.assetresponseAssetResponseSchema = zod_1.z.object({
759
810
  data: exports.assetresponsedataAssetResponseDataSchema
760
811
  }).strict();
761
812
  exports.assetResponseSchema = exports.assetresponseAssetResponseSchema;
813
+ /**
814
+ * The generation models available to this account.
815
+ */
816
+ exports.generationmodellistresponseGenerationModelListResponseSchema = zod_1.z.object({
817
+ models: zod_1.z.array(exports.generationmodelGenerationModelSchema)
818
+ }).strict();
762
819
  /**
763
820
  * The status of an on-demand asset generation job. Completed jobs include the public URL of the generated asset.
764
821
  */
@@ -2448,8 +2505,9 @@ exports.transformationSchema = exports.transformationTransformationSchema;
2448
2505
  *
2449
2506
  * - **Source URL:** set `src` to the URL of an mp4 (or compatible) video file.
2450
2507
  * - **Generated:** set `prompt` to describe the motion. Choose a generator
2451
- * with `model` and configure it with model-specific `options` (including a
2452
- * starting image for image-to-video). The generated `src` is filled in
2508
+ * with `model` and configure it with model-specific `options`. Models that
2509
+ * animate a starting image take it as `options.inputSrc`; the default model
2510
+ * generates from the prompt alone. The generated `src` is filled in
2453
2511
  * automatically.
2454
2512
  * - **Both:** `src` acts as a preview placeholder while `prompt` drives
2455
2513
  * generation — the video is regenerated from the prompt at render time.
@@ -2701,6 +2759,7 @@ exports.renderresponsedataRenderResponseDataSchema = zod_1.z.object({
2701
2759
  'fetching',
2702
2760
  'preprocessing',
2703
2761
  'rendering',
2762
+ 'generating',
2704
2763
  'saving',
2705
2764
  'done',
2706
2765
  'failed'
@@ -2890,6 +2949,28 @@ exports.getGenerateRequest = zod_1.z.object({
2890
2949
  * The generation job has finished (done or failed).
2891
2950
  */
2892
2951
  exports.getGenerateResponse = exports.generationresponseGenerationResponseSchema;
2952
+ exports.getModelsRequest = zod_1.z.object({
2953
+ body: zod_1.z.optional(zod_1.z.never()),
2954
+ path: zod_1.z.optional(zod_1.z.never()),
2955
+ query: zod_1.z.optional(zod_1.z.object({
2956
+ expand: zod_1.z.optional(zod_1.z.enum(['options']))
2957
+ }))
2958
+ }).strict();
2959
+ /**
2960
+ * The available generation models.
2961
+ */
2962
+ exports.getModelsResponse = exports.generationmodellistresponseGenerationModelListResponseSchema;
2963
+ exports.getModelRequest = zod_1.z.object({
2964
+ body: zod_1.z.optional(zod_1.z.never()),
2965
+ path: zod_1.z.object({
2966
+ id: zod_1.z.string()
2967
+ }),
2968
+ query: zod_1.z.optional(zod_1.z.never())
2969
+ }).strict();
2970
+ /**
2971
+ * The generation model, with its option schema.
2972
+ */
2973
+ exports.getModelResponse = exports.generationmodelGenerationModelSchema;
2893
2974
  exports.deleteAssetRequest = zod_1.z.object({
2894
2975
  body: zod_1.z.optional(zod_1.z.never()),
2895
2976
  path: zod_1.z.object({