@shotstack/schemas 1.20.1 → 1.20.2
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 +335 -17
- package/dist/json-schema/edit.json +1 -1
- package/dist/json-schema/index.cjs +1 -1
- package/dist/json-schema/index.js +1 -1
- package/dist/schema.d.ts +345 -17
- package/package.json +3 -2
package/dist/api.bundled.json
CHANGED
|
@@ -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": "
|
|
98
|
+
"type": "rich-text",
|
|
98
99
|
"text": "Hello World",
|
|
99
|
-
"
|
|
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://
|
|
121
|
+
"src": "https://shotstack-assets.s3.amazonaws.com/images/earth.jpg"
|
|
113
122
|
},
|
|
114
|
-
"start":
|
|
115
|
-
"length":
|
|
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://
|
|
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://
|
|
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
|
-
"
|
|
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": {
|
|
@@ -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
|
}
|
|
@@ -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": "
|
|
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.",
|
|
@@ -5383,7 +5614,94 @@
|
|
|
5383
5614
|
"description": "The [Edit](#tocs_edit) template.",
|
|
5384
5615
|
"$ref": "#/components/schemas/Edit",
|
|
5385
5616
|
"example": {
|
|
5386
|
-
"
|
|
5617
|
+
"timeline": {
|
|
5618
|
+
"background": "#000000",
|
|
5619
|
+
"fonts": [
|
|
5620
|
+
{
|
|
5621
|
+
"src": "https://fonts.gstatic.com/s/montserrat/v31/JTUSjIg1_i6t8kCHKm45xW5rygbi49c.ttf"
|
|
5622
|
+
}
|
|
5623
|
+
],
|
|
5624
|
+
"tracks": [
|
|
5625
|
+
{
|
|
5626
|
+
"clips": [
|
|
5627
|
+
{
|
|
5628
|
+
"asset": {
|
|
5629
|
+
"type": "rich-text",
|
|
5630
|
+
"text": "Hello World",
|
|
5631
|
+
"font": {
|
|
5632
|
+
"family": "JTUSjIg1_i6t8kCHKm45xW5rygbi49c",
|
|
5633
|
+
"size": 64,
|
|
5634
|
+
"weight": "700",
|
|
5635
|
+
"color": "#ffffff"
|
|
5636
|
+
},
|
|
5637
|
+
"align": {
|
|
5638
|
+
"horizontal": "center",
|
|
5639
|
+
"vertical": "middle"
|
|
5640
|
+
}
|
|
5641
|
+
},
|
|
5642
|
+
"start": 0,
|
|
5643
|
+
"length": 4,
|
|
5644
|
+
"transition": {
|
|
5645
|
+
"in": "fade",
|
|
5646
|
+
"out": "fade"
|
|
5647
|
+
}
|
|
5648
|
+
},
|
|
5649
|
+
{
|
|
5650
|
+
"asset": {
|
|
5651
|
+
"type": "image",
|
|
5652
|
+
"src": "https://shotstack-assets.s3.amazonaws.com/images/earth.jpg"
|
|
5653
|
+
},
|
|
5654
|
+
"start": 4,
|
|
5655
|
+
"length": 3,
|
|
5656
|
+
"effect": "zoomIn",
|
|
5657
|
+
"filter": "greyscale"
|
|
5658
|
+
}
|
|
5659
|
+
]
|
|
5660
|
+
},
|
|
5661
|
+
{
|
|
5662
|
+
"clips": [
|
|
5663
|
+
{
|
|
5664
|
+
"asset": {
|
|
5665
|
+
"type": "video",
|
|
5666
|
+
"src": "https://shotstack-assets.s3.amazonaws.com/footage/beach.mp4",
|
|
5667
|
+
"transcode": true
|
|
5668
|
+
},
|
|
5669
|
+
"start": 7,
|
|
5670
|
+
"length": 4.5
|
|
5671
|
+
},
|
|
5672
|
+
{
|
|
5673
|
+
"asset": {
|
|
5674
|
+
"type": "video",
|
|
5675
|
+
"src": "https://shotstack-assets.s3.amazonaws.com/footage/city-timelapse.mp4",
|
|
5676
|
+
"volume": 0.5
|
|
5677
|
+
},
|
|
5678
|
+
"start": 11.5,
|
|
5679
|
+
"length": 5,
|
|
5680
|
+
"transition": {
|
|
5681
|
+
"out": "wipeLeft"
|
|
5682
|
+
}
|
|
5683
|
+
}
|
|
5684
|
+
]
|
|
5685
|
+
},
|
|
5686
|
+
{
|
|
5687
|
+
"clips": [
|
|
5688
|
+
{
|
|
5689
|
+
"asset": {
|
|
5690
|
+
"type": "audio",
|
|
5691
|
+
"src": "https://shotstack-assets.s3.amazonaws.com/music/unminus/lit.mp3",
|
|
5692
|
+
"effect": "fadeInFadeOut"
|
|
5693
|
+
},
|
|
5694
|
+
"start": 0,
|
|
5695
|
+
"length": "end"
|
|
5696
|
+
}
|
|
5697
|
+
]
|
|
5698
|
+
}
|
|
5699
|
+
]
|
|
5700
|
+
},
|
|
5701
|
+
"output": {
|
|
5702
|
+
"format": "mp4",
|
|
5703
|
+
"resolution": "sd"
|
|
5704
|
+
}
|
|
5387
5705
|
}
|
|
5388
5706
|
}
|
|
5389
5707
|
},
|
|
@@ -1128,7 +1128,7 @@
|
|
|
1128
1128
|
"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.",
|
|
1129
1129
|
"type": "string",
|
|
1130
1130
|
"examples": [
|
|
1131
|
-
"
|
|
1131
|
+
"nano-banana-2"
|
|
1132
1132
|
]
|
|
1133
1133
|
},
|
|
1134
1134
|
"options": {
|