@shotstack/schemas 1.20.1 → 1.20.3

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
@@ -26,7 +26,7 @@ export interface paths {
26
26
  *
27
27
  * **Video Preprocessing:**
28
28
  * Video assets undergo automatic preprocessing to ensure compatibility. You can force
29
- * preprocessing by setting `"transcode": true` on video assets. See [Preprocessing](#preprocessing)
29
+ * preprocessing by setting `"transcode": true` on video assets. See [VideoAsset](#tocs_videoasset)
30
30
  * for more details.
31
31
  *
32
32
  * **Base URL:** <a href="#">https://api.shotstack.io/edit/{version}</a>
@@ -361,7 +361,7 @@ export interface paths {
361
361
  /**
362
362
  * Get Asset by Render ID
363
363
  * @description A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are
364
- * created the only known id is the render id returned by the original [render request](#render-video), status
364
+ * created the only known id is the render id returned by the original [render request](#render-asset), status
365
365
  * request or webhook. This endpoint lets you look up one or more assets by the render id.
366
366
  *
367
367
  * **Base URL:** <a href="#">https://api.shotstack.io/serve/{version}</a>
@@ -472,7 +472,7 @@ export interface paths {
472
472
  * @description Request a signed URL to upload a file to. The response returns a signed URL that you use to upload the file to.
473
473
  * The signed URL looks similar to:
474
474
  *
475
- * https://shotstack-ingest-api-stage-sources.s3.ap-southeast-2.amazonaws.com/5ca6hu7s9k/zzytey4v-32km-kq1z-aftr-3kcuqi0brad2/source?AWSAccessKeyId=ASIAWJV7UWDMGTZLHTXP&Expires=1677209777&Signature=PKR4dGDDdOuMTAQmDASzLGmLOeo%3D&x-amz-acl=public-read&x-amz-security-token=IQoJb3JpZ2luX2VjEGMaDmFwLX......56osBGByztm7WZdbmXzO09KR
475
+ * `https://shotstack-ingest-api-stage-sources.s3.ap-southeast-2.amazonaws.com/5ca6hu7s9k/zzytey4v-32km-kq1z-aftr-3kcuqi0brad2/source?AWSAccessKeyId=ASIAWJV7UWDMGTZLHTXP&Expires=1677209777&Signature=PKR4dGDDdOuMTAQmDASzLGmLOeo%3D&x-amz-acl=public-read&x-amz-security-token=IQoJb3JpZ2luX2VjEGMaDmFwLX......56osBGByztm7WZdbmXzO09KR`
476
476
  *
477
477
  * In a separate API call, use this signed URL to send a PUT request with the binary file. Using cURL you can use
478
478
  * a command like:
@@ -514,7 +514,7 @@ export interface components {
514
514
  * @deprecated
515
515
  * @description **Notice: This option is now deprecated and will be removed. Disk types are handled automatically. Setting a disk type has no effect.**
516
516
  *
517
- * The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types/) for more details.
517
+ * The disk type to use for storing footage and assets for each render.
518
518
  * <ul>
519
519
  * <li>`local` - optimized for high speed rendering with up to 512MB storage</li>
520
520
  * <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li>
@@ -784,7 +784,7 @@ export interface components {
784
784
  prompt?: string;
785
785
  /**
786
786
  * @description The generation model to use when `prompt` is set (e.g. `flux-schnell`, `nano-banana-2`). Defaults to `nano-banana-2` if omitted. Each model's available options are defined by the model registry.
787
- * @example flux-schnell
787
+ * @example nano-banana-2
788
788
  */
789
789
  model?: string;
790
790
  /**
@@ -895,59 +895,9 @@ export interface components {
895
895
  /** @description Background styling properties for the text bounding box. */
896
896
  background?: components["schemas"]["RichTextBackground"];
897
897
  /** @description Border styling properties for the text bounding box. */
898
- border?: {
899
- /**
900
- * @description The width of the border in pixels. Must be 0 or greater.
901
- * @default 0
902
- * @example 2
903
- */
904
- width?: number;
905
- /**
906
- * @description The border color using hexadecimal color notation.
907
- * @default #000000
908
- * @example #ff0000
909
- */
910
- color?: string;
911
- /**
912
- * @description The opacity of the border where 1 is opaque and 0 is transparent.
913
- * @default 1
914
- * @example 0.8
915
- */
916
- opacity?: number;
917
- /**
918
- * @description The border radius in pixels for rounded corners. Must be 0 or greater.
919
- * @default 0
920
- * @example 10
921
- */
922
- radius?: number;
923
- };
898
+ border?: components["schemas"]["RichTextBorder"];
924
899
  /** @description Padding inside the text bounding box. Can be a single number (applied to all sides) or an object with individual sides. */
925
- padding?: number | {
926
- /**
927
- * @description Top padding in pixels.
928
- * @default 0
929
- * @example 10
930
- */
931
- top?: number;
932
- /**
933
- * @description Right padding in pixels.
934
- * @default 0
935
- * @example 10
936
- */
937
- right?: number;
938
- /**
939
- * @description Bottom padding in pixels.
940
- * @default 0
941
- * @example 10
942
- */
943
- bottom?: number;
944
- /**
945
- * @description Left padding in pixels.
946
- * @default 0
947
- * @example 10
948
- */
949
- left?: number;
950
- };
900
+ padding?: number | components["schemas"]["RichTextPadding"];
951
901
  /** @description Text alignment properties (horizontal and vertical). */
952
902
  align?: components["schemas"]["RichTextAlignment"];
953
903
  /** @description Animation properties for text entrance effects. */
@@ -1273,9 +1223,9 @@ export interface components {
1273
1223
  /** @description Background styling properties for the caption bounding box. */
1274
1224
  background?: components["schemas"]["RichTextBackground"];
1275
1225
  /** @description Border styling properties for the caption bounding box. */
1276
- border?: components["schemas"]["RichTextAsset"]["border"];
1226
+ border?: components["schemas"]["RichTextBorder"];
1277
1227
  /** @description Padding inside the caption bounding box. Can be a single number (applied to all sides) or an object with individual sides. */
1278
- padding?: number | components["schemas"]["RichTextAsset"]["padding"]["oneOf"]["1"];
1228
+ padding?: number | components["schemas"]["RichTextPadding"];
1279
1229
  /** @description Text alignment properties (horizontal and vertical). */
1280
1230
  align?: components["schemas"]["RichTextAlignment"];
1281
1231
  /** @description Styling properties for the active/highlighted word. These override the base styling when a word is being spoken. */
@@ -2133,6 +2083,60 @@ export interface components {
2133
2083
  */
2134
2084
  direction?: "left" | "right" | "up" | "down";
2135
2085
  };
2086
+ /** @description Border styling properties for the text bounding box. */
2087
+ RichTextBorder: {
2088
+ /**
2089
+ * @description The width of the border in pixels. Must be 0 or greater.
2090
+ * @default 0
2091
+ * @example 2
2092
+ */
2093
+ width?: number;
2094
+ /**
2095
+ * @description The border color using hexadecimal color notation.
2096
+ * @default #000000
2097
+ * @example #ff0000
2098
+ */
2099
+ color?: string;
2100
+ /**
2101
+ * @description The opacity of the border where 1 is opaque and 0 is transparent.
2102
+ * @default 1
2103
+ * @example 0.8
2104
+ */
2105
+ opacity?: number;
2106
+ /**
2107
+ * @description The border radius in pixels for rounded corners. Must be 0 or greater.
2108
+ * @default 0
2109
+ * @example 10
2110
+ */
2111
+ radius?: number;
2112
+ };
2113
+ /** @description Padding properties for individual sides of the text bounding box. */
2114
+ RichTextPadding: {
2115
+ /**
2116
+ * @description Top padding in pixels.
2117
+ * @default 0
2118
+ * @example 10
2119
+ */
2120
+ top?: number;
2121
+ /**
2122
+ * @description Right padding in pixels.
2123
+ * @default 0
2124
+ * @example 10
2125
+ */
2126
+ right?: number;
2127
+ /**
2128
+ * @description Bottom padding in pixels.
2129
+ * @default 0
2130
+ * @example 10
2131
+ */
2132
+ bottom?: number;
2133
+ /**
2134
+ * @description Left padding in pixels.
2135
+ * @default 0
2136
+ * @example 10
2137
+ */
2138
+ left?: number;
2139
+ };
2136
2140
  /** @description Font properties for captions text. */
2137
2141
  CaptionFont: {
2138
2142
  /**
@@ -2556,7 +2560,7 @@ export interface components {
2556
2560
  */
2557
2561
  exclude?: boolean;
2558
2562
  };
2559
- /** @description Send videos to the [Mux](https://shotstack.io/docs/guide/serving-assets/destinations/mux/) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request. */
2563
+ /** @description Send videos to the [Mux](https://www.mux.com/docs) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request. */
2560
2564
  MuxDestination: {
2561
2565
  /**
2562
2566
  * @description The destination to send video to - set to `mux` for Mux.
@@ -3299,7 +3303,94 @@ export interface components {
3299
3303
  /**
3300
3304
  * @description The [Edit](#tocs_edit) template.
3301
3305
  * @example {
3302
- * "$ref": "../../definitions/edit.yaml"
3306
+ * "timeline": {
3307
+ * "background": "#000000",
3308
+ * "fonts": [
3309
+ * {
3310
+ * "src": "https://fonts.gstatic.com/s/montserrat/v31/JTUSjIg1_i6t8kCHKm45xW5rygbi49c.ttf"
3311
+ * }
3312
+ * ],
3313
+ * "tracks": [
3314
+ * {
3315
+ * "clips": [
3316
+ * {
3317
+ * "asset": {
3318
+ * "type": "rich-text",
3319
+ * "text": "Hello World",
3320
+ * "font": {
3321
+ * "family": "JTUSjIg1_i6t8kCHKm45xW5rygbi49c",
3322
+ * "size": 64,
3323
+ * "weight": "700",
3324
+ * "color": "#ffffff"
3325
+ * },
3326
+ * "align": {
3327
+ * "horizontal": "center",
3328
+ * "vertical": "middle"
3329
+ * }
3330
+ * },
3331
+ * "start": 0,
3332
+ * "length": 4,
3333
+ * "transition": {
3334
+ * "in": "fade",
3335
+ * "out": "fade"
3336
+ * }
3337
+ * },
3338
+ * {
3339
+ * "asset": {
3340
+ * "type": "image",
3341
+ * "src": "https://shotstack-assets.s3.amazonaws.com/images/earth.jpg"
3342
+ * },
3343
+ * "start": 4,
3344
+ * "length": 3,
3345
+ * "effect": "zoomIn",
3346
+ * "filter": "greyscale"
3347
+ * }
3348
+ * ]
3349
+ * },
3350
+ * {
3351
+ * "clips": [
3352
+ * {
3353
+ * "asset": {
3354
+ * "type": "video",
3355
+ * "src": "https://shotstack-assets.s3.amazonaws.com/footage/beach.mp4",
3356
+ * "transcode": true
3357
+ * },
3358
+ * "start": 7,
3359
+ * "length": 4.5
3360
+ * },
3361
+ * {
3362
+ * "asset": {
3363
+ * "type": "video",
3364
+ * "src": "https://shotstack-assets.s3.amazonaws.com/footage/city-timelapse.mp4",
3365
+ * "volume": 0.5
3366
+ * },
3367
+ * "start": 11.5,
3368
+ * "length": 5,
3369
+ * "transition": {
3370
+ * "out": "wipeLeft"
3371
+ * }
3372
+ * }
3373
+ * ]
3374
+ * },
3375
+ * {
3376
+ * "clips": [
3377
+ * {
3378
+ * "asset": {
3379
+ * "type": "audio",
3380
+ * "src": "https://shotstack-assets.s3.amazonaws.com/music/unminus/lit.mp3",
3381
+ * "effect": "fadeInFadeOut"
3382
+ * },
3383
+ * "start": 0,
3384
+ * "length": "end"
3385
+ * }
3386
+ * ]
3387
+ * }
3388
+ * ]
3389
+ * },
3390
+ * "output": {
3391
+ * "format": "mp4",
3392
+ * "resolution": "sd"
3393
+ * }
3303
3394
  * }
3304
3395
  */
3305
3396
  template: components["schemas"]["Edit"];
@@ -3744,35 +3835,44 @@ export interface operations {
3744
3835
  /**
3745
3836
  * @example {
3746
3837
  * "timeline": {
3747
- * "soundtrack": {
3748
- * "src": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/music.mp3",
3749
- * "effect": "fadeInFadeOut"
3750
- * },
3751
3838
  * "background": "#000000",
3839
+ * "fonts": [
3840
+ * {
3841
+ * "src": "https://fonts.gstatic.com/s/montserrat/v31/JTUSjIg1_i6t8kCHKm45xW5rygbi49c.ttf"
3842
+ * }
3843
+ * ],
3752
3844
  * "tracks": [
3753
3845
  * {
3754
3846
  * "clips": [
3755
3847
  * {
3756
3848
  * "asset": {
3757
- * "type": "title",
3849
+ * "type": "rich-text",
3758
3850
  * "text": "Hello World",
3759
- * "style": "minimal"
3851
+ * "font": {
3852
+ * "family": "JTUSjIg1_i6t8kCHKm45xW5rygbi49c",
3853
+ * "size": 64,
3854
+ * "weight": "700",
3855
+ * "color": "#ffffff"
3856
+ * },
3857
+ * "align": {
3858
+ * "horizontal": "center",
3859
+ * "vertical": "middle"
3860
+ * }
3760
3861
  * },
3761
3862
  * "start": 0,
3762
3863
  * "length": 4,
3763
3864
  * "transition": {
3764
3865
  * "in": "fade",
3765
3866
  * "out": "fade"
3766
- * },
3767
- * "effect": "slideRight"
3867
+ * }
3768
3868
  * },
3769
3869
  * {
3770
3870
  * "asset": {
3771
3871
  * "type": "image",
3772
- * "src": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/my-image.jpg"
3872
+ * "src": "https://shotstack-assets.s3.amazonaws.com/images/earth.jpg"
3773
3873
  * },
3774
- * "start": 3,
3775
- * "length": 4,
3874
+ * "start": 4,
3875
+ * "length": 3,
3776
3876
  * "effect": "zoomIn",
3777
3877
  * "filter": "greyscale"
3778
3878
  * }
@@ -3783,8 +3883,7 @@ export interface operations {
3783
3883
  * {
3784
3884
  * "asset": {
3785
3885
  * "type": "video",
3786
- * "src": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/my-clip-1.mp4",
3787
- * "trim": 10.5,
3886
+ * "src": "https://shotstack-assets.s3.amazonaws.com/footage/beach.mp4",
3788
3887
  * "transcode": true
3789
3888
  * },
3790
3889
  * "start": 7,
@@ -3793,7 +3892,7 @@ export interface operations {
3793
3892
  * {
3794
3893
  * "asset": {
3795
3894
  * "type": "video",
3796
- * "src": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/my-clip-2.mp4",
3895
+ * "src": "https://shotstack-assets.s3.amazonaws.com/footage/city-timelapse.mp4",
3797
3896
  * "volume": 0.5
3798
3897
  * },
3799
3898
  * "start": 11.5,
@@ -3803,6 +3902,19 @@ export interface operations {
3803
3902
  * }
3804
3903
  * }
3805
3904
  * ]
3905
+ * },
3906
+ * {
3907
+ * "clips": [
3908
+ * {
3909
+ * "asset": {
3910
+ * "type": "audio",
3911
+ * "src": "https://shotstack-assets.s3.amazonaws.com/music/unminus/lit.mp3",
3912
+ * "effect": "fadeInFadeOut"
3913
+ * },
3914
+ * "start": 0,
3915
+ * "length": "end"
3916
+ * }
3917
+ * ]
3806
3918
  * }
3807
3919
  * ]
3808
3920
  * },
@@ -3866,7 +3978,94 @@ export interface operations {
3866
3978
  * "owner": "5ca6hu7s9k",
3867
3979
  * "url": "https://shotstack-api-v1-output.s3-ap-southeast-2.amazonaws.com/5ca6hu7s9k/2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7.mp4",
3868
3980
  * "data": {
3869
- * "$ref": "#/paths/~1render/post/requestBody/content/application~1json/example"
3981
+ * "timeline": {
3982
+ * "background": "#000000",
3983
+ * "fonts": [
3984
+ * {
3985
+ * "src": "https://fonts.gstatic.com/s/montserrat/v31/JTUSjIg1_i6t8kCHKm45xW5rygbi49c.ttf"
3986
+ * }
3987
+ * ],
3988
+ * "tracks": [
3989
+ * {
3990
+ * "clips": [
3991
+ * {
3992
+ * "asset": {
3993
+ * "type": "rich-text",
3994
+ * "text": "Hello World",
3995
+ * "font": {
3996
+ * "family": "JTUSjIg1_i6t8kCHKm45xW5rygbi49c",
3997
+ * "size": 64,
3998
+ * "weight": "700",
3999
+ * "color": "#ffffff"
4000
+ * },
4001
+ * "align": {
4002
+ * "horizontal": "center",
4003
+ * "vertical": "middle"
4004
+ * }
4005
+ * },
4006
+ * "start": 0,
4007
+ * "length": 4,
4008
+ * "transition": {
4009
+ * "in": "fade",
4010
+ * "out": "fade"
4011
+ * }
4012
+ * },
4013
+ * {
4014
+ * "asset": {
4015
+ * "type": "image",
4016
+ * "src": "https://shotstack-assets.s3.amazonaws.com/images/earth.jpg"
4017
+ * },
4018
+ * "start": 4,
4019
+ * "length": 3,
4020
+ * "effect": "zoomIn",
4021
+ * "filter": "greyscale"
4022
+ * }
4023
+ * ]
4024
+ * },
4025
+ * {
4026
+ * "clips": [
4027
+ * {
4028
+ * "asset": {
4029
+ * "type": "video",
4030
+ * "src": "https://shotstack-assets.s3.amazonaws.com/footage/beach.mp4",
4031
+ * "transcode": true
4032
+ * },
4033
+ * "start": 7,
4034
+ * "length": 4.5
4035
+ * },
4036
+ * {
4037
+ * "asset": {
4038
+ * "type": "video",
4039
+ * "src": "https://shotstack-assets.s3.amazonaws.com/footage/city-timelapse.mp4",
4040
+ * "volume": 0.5
4041
+ * },
4042
+ * "start": 11.5,
4043
+ * "length": 5,
4044
+ * "transition": {
4045
+ * "out": "wipeLeft"
4046
+ * }
4047
+ * }
4048
+ * ]
4049
+ * },
4050
+ * {
4051
+ * "clips": [
4052
+ * {
4053
+ * "asset": {
4054
+ * "type": "audio",
4055
+ * "src": "https://shotstack-assets.s3.amazonaws.com/music/unminus/lit.mp3",
4056
+ * "effect": "fadeInFadeOut"
4057
+ * },
4058
+ * "start": 0,
4059
+ * "length": "end"
4060
+ * }
4061
+ * ]
4062
+ * }
4063
+ * ]
4064
+ * },
4065
+ * "output": {
4066
+ * "format": "mp4",
4067
+ * "resolution": "sd"
4068
+ * }
3870
4069
  * },
3871
4070
  * "created": "2020-10-30T09:42:29.446Z",
3872
4071
  * "updated": "2020-10-30T09:42:39.168Z"
@@ -3908,6 +4107,57 @@ export interface operations {
3908
4107
  /** @description Create a template with a name and [Edit](#tocs_edit). */
3909
4108
  requestBody: {
3910
4109
  content: {
4110
+ /**
4111
+ * @example {
4112
+ * "name": "Jane's welcome video",
4113
+ * "template": {
4114
+ * "timeline": {
4115
+ * "fonts": [
4116
+ * {
4117
+ * "src": "https://fonts.gstatic.com/s/montserrat/v31/JTUSjIg1_i6t8kCHKm45xW5rygbi49c.ttf"
4118
+ * }
4119
+ * ],
4120
+ * "tracks": [
4121
+ * {
4122
+ * "clips": [
4123
+ * {
4124
+ * "asset": {
4125
+ * "type": "rich-text",
4126
+ * "text": "HELLO {{NAME}}",
4127
+ * "font": {
4128
+ * "family": "JTUSjIg1_i6t8kCHKm45xW5rygbi49c",
4129
+ * "size": 72,
4130
+ * "weight": "800",
4131
+ * "color": "#ffffff"
4132
+ * },
4133
+ * "align": {
4134
+ * "horizontal": "center",
4135
+ * "vertical": "middle"
4136
+ * }
4137
+ * },
4138
+ * "start": 0,
4139
+ * "length": 5
4140
+ * }
4141
+ * ]
4142
+ * }
4143
+ * ]
4144
+ * },
4145
+ * "output": {
4146
+ * "format": "mp4",
4147
+ * "size": {
4148
+ * "width": 1024,
4149
+ * "height": 576
4150
+ * }
4151
+ * },
4152
+ * "merge": [
4153
+ * {
4154
+ * "find": "NAME",
4155
+ * "replace": "World"
4156
+ * }
4157
+ * ]
4158
+ * }
4159
+ * }
4160
+ */
3911
4161
  "application/json": components["schemas"]["Template"];
3912
4162
  };
3913
4163
  };
@@ -3959,6 +4209,57 @@ export interface operations {
3959
4209
  /** @description Update an individual templates name and [Edit](#tocs_edit). Both template name and template must be provided. If the template parameter is omitted a blank template will be saved. */
3960
4210
  requestBody: {
3961
4211
  content: {
4212
+ /**
4213
+ * @example {
4214
+ * "name": "Jane's welcome video",
4215
+ * "template": {
4216
+ * "timeline": {
4217
+ * "fonts": [
4218
+ * {
4219
+ * "src": "https://fonts.gstatic.com/s/montserrat/v31/JTUSjIg1_i6t8kCHKm45xW5rygbi49c.ttf"
4220
+ * }
4221
+ * ],
4222
+ * "tracks": [
4223
+ * {
4224
+ * "clips": [
4225
+ * {
4226
+ * "asset": {
4227
+ * "type": "rich-text",
4228
+ * "text": "HELLO {{NAME}}",
4229
+ * "font": {
4230
+ * "family": "JTUSjIg1_i6t8kCHKm45xW5rygbi49c",
4231
+ * "size": 72,
4232
+ * "weight": "800",
4233
+ * "color": "#ffffff"
4234
+ * },
4235
+ * "align": {
4236
+ * "horizontal": "center",
4237
+ * "vertical": "middle"
4238
+ * }
4239
+ * },
4240
+ * "start": 0,
4241
+ * "length": 5
4242
+ * }
4243
+ * ]
4244
+ * }
4245
+ * ]
4246
+ * },
4247
+ * "output": {
4248
+ * "format": "mp4",
4249
+ * "size": {
4250
+ * "width": 1024,
4251
+ * "height": 576
4252
+ * }
4253
+ * },
4254
+ * "merge": [
4255
+ * {
4256
+ * "find": "NAME",
4257
+ * "replace": "World"
4258
+ * }
4259
+ * ]
4260
+ * }
4261
+ * }
4262
+ */
3962
4263
  "application/json": components["schemas"]["Template"];
3963
4264
  };
3964
4265
  };
@@ -4015,6 +4316,17 @@ export interface operations {
4015
4316
  /** @description Render a template by template id. */
4016
4317
  requestBody: {
4017
4318
  content: {
4319
+ /**
4320
+ * @example {
4321
+ * "id": "f5493c17-d01f-445c-bb49-535fae65f219",
4322
+ * "merge": [
4323
+ * {
4324
+ * "find": "NAME",
4325
+ * "replace": "Jane"
4326
+ * }
4327
+ * ]
4328
+ * }
4329
+ */
4018
4330
  "application/json": components["schemas"]["TemplateRender"];
4019
4331
  };
4020
4332
  };
@@ -4066,6 +4378,15 @@ export interface operations {
4066
4378
  /** @description A prompt-bearing image, video or audio asset to generate. */
4067
4379
  requestBody?: {
4068
4380
  content: {
4381
+ /**
4382
+ * @example {
4383
+ * "asset": {
4384
+ * "type": "image",
4385
+ * "prompt": "A lighthouse on a rocky coast at sunset, cinematic lighting",
4386
+ * "model": "nano-banana-2"
4387
+ * }
4388
+ * }
4389
+ */
4069
4390
  "application/json": {
4070
4391
  asset: components["schemas"]["ImageAsset"] | components["schemas"]["VideoAsset"] | components["schemas"]["AudioAsset"];
4071
4392
  /**
@@ -4338,6 +4659,17 @@ export interface operations {
4338
4659
  /** @description Fetch an asset from a URL and send it to one or more destinations. */
4339
4660
  requestBody: {
4340
4661
  content: {
4662
+ /**
4663
+ * @example {
4664
+ * "url": "https://s3-ap-southeast-2.amazonaws.com/shotstack-assets/music/moment.mp3",
4665
+ * "id": "018e8937-5015-75ee-aab6-03f214981133",
4666
+ * "destinations": [
4667
+ * {
4668
+ * "provider": "shotstack"
4669
+ * }
4670
+ * ]
4671
+ * }
4672
+ */
4341
4673
  "application/json": components["schemas"]["Transfer"];
4342
4674
  };
4343
4675
  };