@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.
@@ -75,7 +75,7 @@
75
75
  }
76
76
  }
77
77
  },
78
- "description": "Queue and render the contents of an [Edit](#tocs_edit) as a video, image or audio file.\n\n**Rendering Process:**\n1. **Validation**: The edit JSON is validated\n2. **Download**: All assets are downloaded and cached \n3. **Preprocessing**: Video assets are automatically processed to fix compatibility issues\n4. **Rendering**: The timeline is rendered using the processed assets\n5. **Output**: The final media file is generated and stored\n\n**Video Preprocessing:**\nVideo assets undergo automatic preprocessing to ensure compatibility. You can force \npreprocessing by setting `\"transcode\": true` on video assets. See [Preprocessing](#preprocessing) \nfor more details.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>\n",
78
+ "description": "Queue and render the contents of an [Edit](#tocs_edit) as a video, image or audio file.\n\n**Rendering Process:**\n1. **Validation**: The edit JSON is validated\n2. **Download**: All assets are downloaded and cached \n3. **Preprocessing**: Video assets are automatically processed to fix compatibility issues\n4. **Rendering**: The timeline is rendered using the processed assets\n5. **Output**: The final media file is generated and stored\n\n**Video Preprocessing:**\nVideo assets undergo automatic preprocessing to ensure compatibility. You can force \npreprocessing by setting `\"transcode\": true` on video assets. See [VideoAsset](#tocs_videoasset) \nfor more details.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>\n",
79
79
  "summary": "Render Asset",
80
80
  "operationId": "postRender",
81
81
  "requestBody": {
@@ -84,35 +84,44 @@
84
84
  "application/json": {
85
85
  "example": {
86
86
  "timeline": {
87
- "soundtrack": {
88
- "src": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/music.mp3",
89
- "effect": "fadeInFadeOut"
90
- },
91
87
  "background": "#000000",
88
+ "fonts": [
89
+ {
90
+ "src": "https://fonts.gstatic.com/s/montserrat/v31/JTUSjIg1_i6t8kCHKm45xW5rygbi49c.ttf"
91
+ }
92
+ ],
92
93
  "tracks": [
93
94
  {
94
95
  "clips": [
95
96
  {
96
97
  "asset": {
97
- "type": "title",
98
+ "type": "rich-text",
98
99
  "text": "Hello World",
99
- "style": "minimal"
100
+ "font": {
101
+ "family": "JTUSjIg1_i6t8kCHKm45xW5rygbi49c",
102
+ "size": 64,
103
+ "weight": "700",
104
+ "color": "#ffffff"
105
+ },
106
+ "align": {
107
+ "horizontal": "center",
108
+ "vertical": "middle"
109
+ }
100
110
  },
101
111
  "start": 0,
102
112
  "length": 4,
103
113
  "transition": {
104
114
  "in": "fade",
105
115
  "out": "fade"
106
- },
107
- "effect": "slideRight"
116
+ }
108
117
  },
109
118
  {
110
119
  "asset": {
111
120
  "type": "image",
112
- "src": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/my-image.jpg"
121
+ "src": "https://shotstack-assets.s3.amazonaws.com/images/earth.jpg"
113
122
  },
114
- "start": 3,
115
- "length": 4,
123
+ "start": 4,
124
+ "length": 3,
116
125
  "effect": "zoomIn",
117
126
  "filter": "greyscale"
118
127
  }
@@ -123,8 +132,7 @@
123
132
  {
124
133
  "asset": {
125
134
  "type": "video",
126
- "src": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/my-clip-1.mp4",
127
- "trim": 10.5,
135
+ "src": "https://shotstack-assets.s3.amazonaws.com/footage/beach.mp4",
128
136
  "transcode": true
129
137
  },
130
138
  "start": 7,
@@ -133,7 +141,7 @@
133
141
  {
134
142
  "asset": {
135
143
  "type": "video",
136
- "src": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/my-clip-2.mp4",
144
+ "src": "https://shotstack-assets.s3.amazonaws.com/footage/city-timelapse.mp4",
137
145
  "volume": 0.5
138
146
  },
139
147
  "start": 11.5,
@@ -143,6 +151,19 @@
143
151
  }
144
152
  }
145
153
  ]
154
+ },
155
+ {
156
+ "clips": [
157
+ {
158
+ "asset": {
159
+ "type": "audio",
160
+ "src": "https://shotstack-assets.s3.amazonaws.com/music/unminus/lit.mp3",
161
+ "effect": "fadeInFadeOut"
162
+ },
163
+ "start": 0,
164
+ "length": "end"
165
+ }
166
+ ]
146
167
  }
147
168
  ]
148
169
  },
@@ -184,7 +205,94 @@
184
205
  "owner": "5ca6hu7s9k",
185
206
  "url": "https://shotstack-api-v1-output.s3-ap-southeast-2.amazonaws.com/5ca6hu7s9k/2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7.mp4",
186
207
  "data": {
187
- "$ref": "#/paths/~1render/post/requestBody/content/application~1json/example"
208
+ "timeline": {
209
+ "background": "#000000",
210
+ "fonts": [
211
+ {
212
+ "src": "https://fonts.gstatic.com/s/montserrat/v31/JTUSjIg1_i6t8kCHKm45xW5rygbi49c.ttf"
213
+ }
214
+ ],
215
+ "tracks": [
216
+ {
217
+ "clips": [
218
+ {
219
+ "asset": {
220
+ "type": "rich-text",
221
+ "text": "Hello World",
222
+ "font": {
223
+ "family": "JTUSjIg1_i6t8kCHKm45xW5rygbi49c",
224
+ "size": 64,
225
+ "weight": "700",
226
+ "color": "#ffffff"
227
+ },
228
+ "align": {
229
+ "horizontal": "center",
230
+ "vertical": "middle"
231
+ }
232
+ },
233
+ "start": 0,
234
+ "length": 4,
235
+ "transition": {
236
+ "in": "fade",
237
+ "out": "fade"
238
+ }
239
+ },
240
+ {
241
+ "asset": {
242
+ "type": "image",
243
+ "src": "https://shotstack-assets.s3.amazonaws.com/images/earth.jpg"
244
+ },
245
+ "start": 4,
246
+ "length": 3,
247
+ "effect": "zoomIn",
248
+ "filter": "greyscale"
249
+ }
250
+ ]
251
+ },
252
+ {
253
+ "clips": [
254
+ {
255
+ "asset": {
256
+ "type": "video",
257
+ "src": "https://shotstack-assets.s3.amazonaws.com/footage/beach.mp4",
258
+ "transcode": true
259
+ },
260
+ "start": 7,
261
+ "length": 4.5
262
+ },
263
+ {
264
+ "asset": {
265
+ "type": "video",
266
+ "src": "https://shotstack-assets.s3.amazonaws.com/footage/city-timelapse.mp4",
267
+ "volume": 0.5
268
+ },
269
+ "start": 11.5,
270
+ "length": 5,
271
+ "transition": {
272
+ "out": "wipeLeft"
273
+ }
274
+ }
275
+ ]
276
+ },
277
+ {
278
+ "clips": [
279
+ {
280
+ "asset": {
281
+ "type": "audio",
282
+ "src": "https://shotstack-assets.s3.amazonaws.com/music/unminus/lit.mp3",
283
+ "effect": "fadeInFadeOut"
284
+ },
285
+ "start": 0,
286
+ "length": "end"
287
+ }
288
+ ]
289
+ }
290
+ ]
291
+ },
292
+ "output": {
293
+ "format": "mp4",
294
+ "resolution": "sd"
295
+ }
188
296
  },
189
297
  "created": "2020-10-30T09:42:29.446Z",
190
298
  "updated": "2020-10-30T09:42:39.168Z"
@@ -249,6 +357,55 @@
249
357
  "description": "Create a template with a name and [Edit](#tocs_edit).",
250
358
  "content": {
251
359
  "application/json": {
360
+ "example": {
361
+ "name": "Jane's welcome video",
362
+ "template": {
363
+ "timeline": {
364
+ "fonts": [
365
+ {
366
+ "src": "https://fonts.gstatic.com/s/montserrat/v31/JTUSjIg1_i6t8kCHKm45xW5rygbi49c.ttf"
367
+ }
368
+ ],
369
+ "tracks": [
370
+ {
371
+ "clips": [
372
+ {
373
+ "asset": {
374
+ "type": "rich-text",
375
+ "text": "HELLO {{NAME}}",
376
+ "font": {
377
+ "family": "JTUSjIg1_i6t8kCHKm45xW5rygbi49c",
378
+ "size": 72,
379
+ "weight": "800",
380
+ "color": "#ffffff"
381
+ },
382
+ "align": {
383
+ "horizontal": "center",
384
+ "vertical": "middle"
385
+ }
386
+ },
387
+ "start": 0,
388
+ "length": 5
389
+ }
390
+ ]
391
+ }
392
+ ]
393
+ },
394
+ "output": {
395
+ "format": "mp4",
396
+ "size": {
397
+ "width": 1024,
398
+ "height": 576
399
+ }
400
+ },
401
+ "merge": [
402
+ {
403
+ "find": "NAME",
404
+ "replace": "World"
405
+ }
406
+ ]
407
+ }
408
+ },
252
409
  "schema": {
253
410
  "$ref": "#/components/schemas/Template"
254
411
  }
@@ -337,6 +494,55 @@
337
494
  "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.",
338
495
  "content": {
339
496
  "application/json": {
497
+ "example": {
498
+ "name": "Jane's welcome video",
499
+ "template": {
500
+ "timeline": {
501
+ "fonts": [
502
+ {
503
+ "src": "https://fonts.gstatic.com/s/montserrat/v31/JTUSjIg1_i6t8kCHKm45xW5rygbi49c.ttf"
504
+ }
505
+ ],
506
+ "tracks": [
507
+ {
508
+ "clips": [
509
+ {
510
+ "asset": {
511
+ "type": "rich-text",
512
+ "text": "HELLO {{NAME}}",
513
+ "font": {
514
+ "family": "JTUSjIg1_i6t8kCHKm45xW5rygbi49c",
515
+ "size": 72,
516
+ "weight": "800",
517
+ "color": "#ffffff"
518
+ },
519
+ "align": {
520
+ "horizontal": "center",
521
+ "vertical": "middle"
522
+ }
523
+ },
524
+ "start": 0,
525
+ "length": 5
526
+ }
527
+ ]
528
+ }
529
+ ]
530
+ },
531
+ "output": {
532
+ "format": "mp4",
533
+ "size": {
534
+ "width": 1024,
535
+ "height": 576
536
+ }
537
+ },
538
+ "merge": [
539
+ {
540
+ "find": "NAME",
541
+ "replace": "World"
542
+ }
543
+ ]
544
+ }
545
+ },
340
546
  "schema": {
341
547
  "$ref": "#/components/schemas/Template"
342
548
  }
@@ -413,6 +619,15 @@
413
619
  "description": "Render a template by template id.",
414
620
  "content": {
415
621
  "application/json": {
622
+ "example": {
623
+ "id": "f5493c17-d01f-445c-bb49-535fae65f219",
624
+ "merge": [
625
+ {
626
+ "find": "NAME",
627
+ "replace": "Jane"
628
+ }
629
+ ]
630
+ },
416
631
  "schema": {
417
632
  "$ref": "#/components/schemas/TemplateRender"
418
633
  }
@@ -604,6 +819,13 @@
604
819
  "description": "A prompt-bearing image, video or audio asset to generate.",
605
820
  "content": {
606
821
  "application/json": {
822
+ "example": {
823
+ "asset": {
824
+ "type": "image",
825
+ "prompt": "A lighthouse on a rocky coast at sunset, cinematic lighting",
826
+ "model": "nano-banana-2"
827
+ }
828
+ },
607
829
  "schema": {
608
830
  "type": "object",
609
831
  "properties": {
@@ -873,7 +1095,7 @@
873
1095
  }
874
1096
  }
875
1097
  },
876
- "description": "A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are\ncreated the only known id is the render id returned by the original [render request](#render-video), status \nrequest or webhook. This endpoint lets you look up one or more assets by the render id.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/serve/{version}</a>\n",
1098
+ "description": "A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are\ncreated the only known id is the render id returned by the original [render request](#render-asset), status \nrequest or webhook. This endpoint lets you look up one or more assets by the render id.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/serve/{version}</a>\n",
877
1099
  "operationId": "getAssetByRenderId",
878
1100
  "summary": "Get Asset by Render ID",
879
1101
  "security": [
@@ -907,6 +1129,15 @@
907
1129
  "description": "Fetch an asset from a URL and send it to one or more destinations.",
908
1130
  "content": {
909
1131
  "application/json": {
1132
+ "example": {
1133
+ "url": "https://s3-ap-southeast-2.amazonaws.com/shotstack-assets/music/moment.mp3",
1134
+ "id": "018e8937-5015-75ee-aab6-03f214981133",
1135
+ "destinations": [
1136
+ {
1137
+ "provider": "shotstack"
1138
+ }
1139
+ ]
1140
+ },
910
1141
  "schema": {
911
1142
  "$ref": "#/components/schemas/Transfer"
912
1143
  }
@@ -1083,7 +1314,7 @@
1083
1314
  }
1084
1315
  }
1085
1316
  },
1086
- "description": "Request a signed URL to upload a file to. The response returns a signed URL that you use to upload the file to.\nThe signed URL looks similar to:\n\nhttps://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\n\nIn a separate API call, use this signed URL to send a PUT request with the binary file. Using cURL you can use\na command like:\n \n`curl -X PUT -T video.mp4 {data.attributes.url}`\n \nWhere **video.mp4** is the file you want to upload and **{data.attributes.url}** is the signed URL returned in\nthe response. The request must be a PUT type.\n\nThe SDK does not currently support the PUT request. You can use the SDK to make the request for the signed URL\nand then use cURL to make the PUT request.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/ingest/{version}</a>\n",
1317
+ "description": "Request a signed URL to upload a file to. The response returns a signed URL that you use to upload the file to.\nThe signed URL looks similar to:\n\n`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`\n\nIn a separate API call, use this signed URL to send a PUT request with the binary file. Using cURL you can use\na command like:\n \n`curl -X PUT -T video.mp4 {data.attributes.url}`\n \nWhere **video.mp4** is the file you want to upload and **{data.attributes.url}** is the signed URL returned in\nthe response. The request must be a PUT type.\n\nThe SDK does not currently support the PUT request. You can use the SDK to make the request for the signed URL\nand then use cURL to make the PUT request.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/ingest/{version}</a>\n",
1087
1318
  "summary": "Direct Upload",
1088
1319
  "operationId": "getUploadSignedUrl",
1089
1320
  "security": [
@@ -1121,7 +1352,7 @@
1121
1352
  "example": "https://my-server.com/callback.php"
1122
1353
  },
1123
1354
  "disk": {
1124
- "description": "**Notice: This option is now deprecated and will be removed. Disk types are handled automatically. Setting a disk type has no effect.**\n\nThe 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.\n<ul>\n <li>`local` - optimized for high speed rendering with up to 512MB storage</li>\n <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li>\n</ul>\n",
1355
+ "description": "**Notice: This option is now deprecated and will be removed. Disk types are handled automatically. Setting a disk type has no effect.**\n\nThe disk type to use for storing footage and assets for each render.\n<ul>\n <li>`local` - optimized for high speed rendering with up to 512MB storage</li>\n <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li>\n</ul>\n",
1125
1356
  "type": "string",
1126
1357
  "enum": [
1127
1358
  "local",
@@ -1652,7 +1883,7 @@
1652
1883
  "model": {
1653
1884
  "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.",
1654
1885
  "type": "string",
1655
- "example": "flux-schnell"
1886
+ "example": "nano-banana-2"
1656
1887
  },
1657
1888
  "options": {
1658
1889
  "description": "Model-specific generation settings. Valid keys and values depend on the chosen `model` and are defined by the model registry. Omitted options use the model's defaults. Unknown or invalid options are rejected.",
@@ -1809,39 +2040,7 @@
1809
2040
  },
1810
2041
  "border": {
1811
2042
  "description": "Border styling properties for the text bounding box.",
1812
- "properties": {
1813
- "width": {
1814
- "description": "The width of the border in pixels. Must be 0 or greater.",
1815
- "type": "number",
1816
- "minimum": 0,
1817
- "default": 0,
1818
- "example": 2
1819
- },
1820
- "color": {
1821
- "description": "The border color using hexadecimal color notation.",
1822
- "type": "string",
1823
- "pattern": "^#[A-Fa-f0-9]{6}$",
1824
- "default": "#000000",
1825
- "example": "#ff0000"
1826
- },
1827
- "opacity": {
1828
- "description": "The opacity of the border where 1 is opaque and 0 is transparent.",
1829
- "type": "number",
1830
- "minimum": 0,
1831
- "maximum": 1,
1832
- "default": 1,
1833
- "example": 0.8
1834
- },
1835
- "radius": {
1836
- "description": "The border radius in pixels for rounded corners. Must be 0 or greater.",
1837
- "type": "number",
1838
- "minimum": 0,
1839
- "default": 0,
1840
- "example": 10
1841
- }
1842
- },
1843
- "additionalProperties": false,
1844
- "type": "object"
2043
+ "$ref": "#/components/schemas/RichTextBorder"
1845
2044
  },
1846
2045
  "padding": {
1847
2046
  "description": "Padding inside the text bounding box. Can be a single number (applied to all sides) or an object with individual sides.",
@@ -1853,39 +2052,7 @@
1853
2052
  "example": 10
1854
2053
  },
1855
2054
  {
1856
- "description": "Padding properties for individual sides of the text bounding box.",
1857
- "properties": {
1858
- "top": {
1859
- "description": "Top padding in pixels.",
1860
- "type": "number",
1861
- "minimum": 0,
1862
- "default": 0,
1863
- "example": 10
1864
- },
1865
- "right": {
1866
- "description": "Right padding in pixels.",
1867
- "type": "number",
1868
- "minimum": 0,
1869
- "default": 0,
1870
- "example": 10
1871
- },
1872
- "bottom": {
1873
- "description": "Bottom padding in pixels.",
1874
- "type": "number",
1875
- "minimum": 0,
1876
- "default": 0,
1877
- "example": 10
1878
- },
1879
- "left": {
1880
- "description": "Left padding in pixels.",
1881
- "type": "number",
1882
- "minimum": 0,
1883
- "default": 0,
1884
- "example": 10
1885
- }
1886
- },
1887
- "additionalProperties": false,
1888
- "type": "object"
2055
+ "$ref": "#/components/schemas/RichTextPadding"
1889
2056
  }
1890
2057
  ]
1891
2058
  },
@@ -2350,7 +2517,7 @@
2350
2517
  },
2351
2518
  "border": {
2352
2519
  "description": "Border styling properties for the caption bounding box.",
2353
- "$ref": "#/components/schemas/RichTextAsset/properties/border"
2520
+ "$ref": "#/components/schemas/RichTextBorder"
2354
2521
  },
2355
2522
  "padding": {
2356
2523
  "description": "Padding inside the caption bounding box. Can be a single number (applied to all sides) or an object with individual sides.",
@@ -2362,7 +2529,7 @@
2362
2529
  "example": 10
2363
2530
  },
2364
2531
  {
2365
- "$ref": "#/components/schemas/RichTextAsset/properties/padding/oneOf/1"
2532
+ "$ref": "#/components/schemas/RichTextPadding"
2366
2533
  }
2367
2534
  ]
2368
2535
  },
@@ -3699,6 +3866,77 @@
3699
3866
  "additionalProperties": false,
3700
3867
  "type": "object"
3701
3868
  },
3869
+ "RichTextBorder": {
3870
+ "description": "Border styling properties for the text bounding box.",
3871
+ "properties": {
3872
+ "width": {
3873
+ "description": "The width of the border in pixels. Must be 0 or greater.",
3874
+ "type": "number",
3875
+ "minimum": 0,
3876
+ "default": 0,
3877
+ "example": 2
3878
+ },
3879
+ "color": {
3880
+ "description": "The border color using hexadecimal color notation.",
3881
+ "type": "string",
3882
+ "pattern": "^#[A-Fa-f0-9]{6}$",
3883
+ "default": "#000000",
3884
+ "example": "#ff0000"
3885
+ },
3886
+ "opacity": {
3887
+ "description": "The opacity of the border where 1 is opaque and 0 is transparent.",
3888
+ "type": "number",
3889
+ "minimum": 0,
3890
+ "maximum": 1,
3891
+ "default": 1,
3892
+ "example": 0.8
3893
+ },
3894
+ "radius": {
3895
+ "description": "The border radius in pixels for rounded corners. Must be 0 or greater.",
3896
+ "type": "number",
3897
+ "minimum": 0,
3898
+ "default": 0,
3899
+ "example": 10
3900
+ }
3901
+ },
3902
+ "additionalProperties": false,
3903
+ "type": "object"
3904
+ },
3905
+ "RichTextPadding": {
3906
+ "description": "Padding properties for individual sides of the text bounding box.",
3907
+ "properties": {
3908
+ "top": {
3909
+ "description": "Top padding in pixels.",
3910
+ "type": "number",
3911
+ "minimum": 0,
3912
+ "default": 0,
3913
+ "example": 10
3914
+ },
3915
+ "right": {
3916
+ "description": "Right padding in pixels.",
3917
+ "type": "number",
3918
+ "minimum": 0,
3919
+ "default": 0,
3920
+ "example": 10
3921
+ },
3922
+ "bottom": {
3923
+ "description": "Bottom padding in pixels.",
3924
+ "type": "number",
3925
+ "minimum": 0,
3926
+ "default": 0,
3927
+ "example": 10
3928
+ },
3929
+ "left": {
3930
+ "description": "Left padding in pixels.",
3931
+ "type": "number",
3932
+ "minimum": 0,
3933
+ "default": 0,
3934
+ "example": 10
3935
+ }
3936
+ },
3937
+ "additionalProperties": false,
3938
+ "type": "object"
3939
+ },
3702
3940
  "CaptionFont": {
3703
3941
  "description": "Font properties for captions text.",
3704
3942
  "properties": {
@@ -4187,7 +4425,7 @@
4187
4425
  ]
4188
4426
  },
4189
4427
  {
4190
- "description": "Send videos and assets to [Akamai NetStorage](https://techdocs.akamai.com/netstorage-usage/docs). Send files to your NetStorage upload directory with a custom path and filename. Akamai credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/akamai-netstorage), not in the request.",
4428
+ "description": "Send videos and assets to [Akamai NetStorage](https://techdocs.akamai.com/netstorage/docs). Send files to your NetStorage upload directory with a custom path and filename. Akamai credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/akamai-netstorage), not in the request.",
4191
4429
  "properties": {
4192
4430
  "provider": {
4193
4431
  "description": "The destination to send assets to - set to `akamai-netstorage` for Akamai NetStorage.",
@@ -4302,7 +4540,7 @@
4302
4540
  ]
4303
4541
  },
4304
4542
  "MuxDestination": {
4305
- "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.",
4543
+ "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.",
4306
4544
  "properties": {
4307
4545
  "provider": {
4308
4546
  "description": "The destination to send video to - set to `mux` for Mux.",
@@ -5383,7 +5621,94 @@
5383
5621
  "description": "The [Edit](#tocs_edit) template.",
5384
5622
  "$ref": "#/components/schemas/Edit",
5385
5623
  "example": {
5386
- "$ref": "../../definitions/edit.yaml"
5624
+ "timeline": {
5625
+ "background": "#000000",
5626
+ "fonts": [
5627
+ {
5628
+ "src": "https://fonts.gstatic.com/s/montserrat/v31/JTUSjIg1_i6t8kCHKm45xW5rygbi49c.ttf"
5629
+ }
5630
+ ],
5631
+ "tracks": [
5632
+ {
5633
+ "clips": [
5634
+ {
5635
+ "asset": {
5636
+ "type": "rich-text",
5637
+ "text": "Hello World",
5638
+ "font": {
5639
+ "family": "JTUSjIg1_i6t8kCHKm45xW5rygbi49c",
5640
+ "size": 64,
5641
+ "weight": "700",
5642
+ "color": "#ffffff"
5643
+ },
5644
+ "align": {
5645
+ "horizontal": "center",
5646
+ "vertical": "middle"
5647
+ }
5648
+ },
5649
+ "start": 0,
5650
+ "length": 4,
5651
+ "transition": {
5652
+ "in": "fade",
5653
+ "out": "fade"
5654
+ }
5655
+ },
5656
+ {
5657
+ "asset": {
5658
+ "type": "image",
5659
+ "src": "https://shotstack-assets.s3.amazonaws.com/images/earth.jpg"
5660
+ },
5661
+ "start": 4,
5662
+ "length": 3,
5663
+ "effect": "zoomIn",
5664
+ "filter": "greyscale"
5665
+ }
5666
+ ]
5667
+ },
5668
+ {
5669
+ "clips": [
5670
+ {
5671
+ "asset": {
5672
+ "type": "video",
5673
+ "src": "https://shotstack-assets.s3.amazonaws.com/footage/beach.mp4",
5674
+ "transcode": true
5675
+ },
5676
+ "start": 7,
5677
+ "length": 4.5
5678
+ },
5679
+ {
5680
+ "asset": {
5681
+ "type": "video",
5682
+ "src": "https://shotstack-assets.s3.amazonaws.com/footage/city-timelapse.mp4",
5683
+ "volume": 0.5
5684
+ },
5685
+ "start": 11.5,
5686
+ "length": 5,
5687
+ "transition": {
5688
+ "out": "wipeLeft"
5689
+ }
5690
+ }
5691
+ ]
5692
+ },
5693
+ {
5694
+ "clips": [
5695
+ {
5696
+ "asset": {
5697
+ "type": "audio",
5698
+ "src": "https://shotstack-assets.s3.amazonaws.com/music/unminus/lit.mp3",
5699
+ "effect": "fadeInFadeOut"
5700
+ },
5701
+ "start": 0,
5702
+ "length": "end"
5703
+ }
5704
+ ]
5705
+ }
5706
+ ]
5707
+ },
5708
+ "output": {
5709
+ "format": "mp4",
5710
+ "resolution": "sd"
5711
+ }
5387
5712
  }
5388
5713
  }
5389
5714
  },