@shotstack/schemas 1.20.0 → 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 +719 -219
- 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 +594 -147
- package/dist/zod/zod.gen.cjs +55 -10
- package/dist/zod/zod.gen.d.ts +154 -6
- package/dist/zod/zod.gen.js +49 -4
- package/dist/zod/zod.gen.ts +39 -4
- 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
|
}
|
|
@@ -484,43 +699,11 @@
|
|
|
484
699
|
"post": {
|
|
485
700
|
"responses": {
|
|
486
701
|
"200": {
|
|
487
|
-
"description": "The
|
|
702
|
+
"description": "The asset was generated before: `done` with its URL, or `failed` with the error that ended it.",
|
|
488
703
|
"content": {
|
|
489
704
|
"application/json": {
|
|
490
705
|
"schema": {
|
|
491
|
-
"
|
|
492
|
-
"type": "object",
|
|
493
|
-
"properties": {
|
|
494
|
-
"id": {
|
|
495
|
-
"description": "The generation job id. Deterministic for a given owner and asset payload (or idempotency key), so identical requests return the same job and cached result.",
|
|
496
|
-
"type": "string",
|
|
497
|
-
"example": "8a1f2c3d-4e5b-5a6c-9d7e-1f2a3b4c5d6e"
|
|
498
|
-
},
|
|
499
|
-
"status": {
|
|
500
|
-
"description": "The status of the generation job.",
|
|
501
|
-
"type": "string",
|
|
502
|
-
"enum": [
|
|
503
|
-
"queued",
|
|
504
|
-
"processing",
|
|
505
|
-
"done",
|
|
506
|
-
"failed"
|
|
507
|
-
],
|
|
508
|
-
"example": "done"
|
|
509
|
-
},
|
|
510
|
-
"url": {
|
|
511
|
-
"description": "The public URL of the generated asset. Present only when `status` is `done`.",
|
|
512
|
-
"type": "string",
|
|
513
|
-
"example": "https://shotstack-api-v1-output.s3-ap-southeast-2.amazonaws.com/owner/8a1f2c3d.png"
|
|
514
|
-
},
|
|
515
|
-
"error": {
|
|
516
|
-
"description": "A human readable error message. Present only when `status` is `failed`.",
|
|
517
|
-
"type": "string"
|
|
518
|
-
}
|
|
519
|
-
},
|
|
520
|
-
"required": [
|
|
521
|
-
"id",
|
|
522
|
-
"status"
|
|
523
|
-
]
|
|
706
|
+
"$ref": "#/components/schemas/GenerationResponse"
|
|
524
707
|
}
|
|
525
708
|
}
|
|
526
709
|
}
|
|
@@ -544,7 +727,75 @@
|
|
|
544
727
|
"content": {
|
|
545
728
|
"application/json": {
|
|
546
729
|
"schema": {
|
|
547
|
-
"$ref": "#/
|
|
730
|
+
"$ref": "#/components/schemas/GenerationResponse"
|
|
731
|
+
}
|
|
732
|
+
}
|
|
733
|
+
}
|
|
734
|
+
},
|
|
735
|
+
"400": {
|
|
736
|
+
"description": "The request is invalid, for example a missing asset or prompt, a disallowed URL or a `length` that is not positive.",
|
|
737
|
+
"content": {
|
|
738
|
+
"application/json": {
|
|
739
|
+
"schema": {
|
|
740
|
+
"$ref": "#/components/schemas/GenerationErrorResponse"
|
|
741
|
+
}
|
|
742
|
+
}
|
|
743
|
+
}
|
|
744
|
+
},
|
|
745
|
+
"402": {
|
|
746
|
+
"description": "The account has too few credits for this generation. `available` holds how many it has.",
|
|
747
|
+
"content": {
|
|
748
|
+
"application/json": {
|
|
749
|
+
"schema": {
|
|
750
|
+
"$ref": "#/components/schemas/GenerationErrorResponse"
|
|
751
|
+
}
|
|
752
|
+
}
|
|
753
|
+
}
|
|
754
|
+
},
|
|
755
|
+
"403": {
|
|
756
|
+
"description": "The account cannot use this generation. `code` says why.",
|
|
757
|
+
"content": {
|
|
758
|
+
"application/json": {
|
|
759
|
+
"schema": {
|
|
760
|
+
"$ref": "#/components/schemas/GenerationErrorResponse"
|
|
761
|
+
}
|
|
762
|
+
}
|
|
763
|
+
}
|
|
764
|
+
},
|
|
765
|
+
"409": {
|
|
766
|
+
"description": "The `Idempotency-Key` was already used for a different asset.",
|
|
767
|
+
"content": {
|
|
768
|
+
"application/json": {
|
|
769
|
+
"schema": {
|
|
770
|
+
"$ref": "#/components/schemas/GenerationErrorResponse"
|
|
771
|
+
}
|
|
772
|
+
}
|
|
773
|
+
}
|
|
774
|
+
},
|
|
775
|
+
"429": {
|
|
776
|
+
"description": "The account has reached its generation quota.",
|
|
777
|
+
"content": {
|
|
778
|
+
"application/json": {
|
|
779
|
+
"schema": {
|
|
780
|
+
"$ref": "#/components/schemas/GenerationErrorResponse"
|
|
781
|
+
}
|
|
782
|
+
}
|
|
783
|
+
}
|
|
784
|
+
},
|
|
785
|
+
"503": {
|
|
786
|
+
"description": "A service the request depends on is temporarily unavailable. `code` is `AiAccessUnavailable` when access to AI generation could not be confirmed.",
|
|
787
|
+
"headers": {
|
|
788
|
+
"Retry-After": {
|
|
789
|
+
"description": "Suggested seconds to wait before retrying.",
|
|
790
|
+
"schema": {
|
|
791
|
+
"type": "integer"
|
|
792
|
+
}
|
|
793
|
+
}
|
|
794
|
+
},
|
|
795
|
+
"content": {
|
|
796
|
+
"application/json": {
|
|
797
|
+
"schema": {
|
|
798
|
+
"$ref": "#/components/schemas/GenerationErrorResponse"
|
|
548
799
|
}
|
|
549
800
|
}
|
|
550
801
|
}
|
|
@@ -553,10 +804,28 @@
|
|
|
553
804
|
"description": "Generate a single image, video or audio asset from a text prompt without\nrendering a full edit. Submit a prompt-bearing asset; the response is\nimmediate when an identical asset has been generated before (results are\ncached by prompt, model and options), otherwise the job is queued and can\nbe polled via the status endpoint.\n\nGeneration is billed in credits per asset. Identical repeat requests\nresolve from the cache at no charge.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>\n",
|
|
554
805
|
"summary": "Generate Asset",
|
|
555
806
|
"operationId": "postGenerate",
|
|
807
|
+
"parameters": [
|
|
808
|
+
{
|
|
809
|
+
"in": "header",
|
|
810
|
+
"name": "Idempotency-Key",
|
|
811
|
+
"required": false,
|
|
812
|
+
"description": "A key that makes this request its own generation. Retrying with the same key returns the job it first created instead of generating and billing again, and a new key generates afresh even when the asset matches an earlier one. Without a key, identical assets share one cached result. For 24 hours a key reused for a different asset is rejected; after that it returns its first result.",
|
|
813
|
+
"schema": {
|
|
814
|
+
"type": "string"
|
|
815
|
+
}
|
|
816
|
+
}
|
|
817
|
+
],
|
|
556
818
|
"requestBody": {
|
|
557
819
|
"description": "A prompt-bearing image, video or audio asset to generate.",
|
|
558
820
|
"content": {
|
|
559
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
|
+
},
|
|
560
829
|
"schema": {
|
|
561
830
|
"type": "object",
|
|
562
831
|
"properties": {
|
|
@@ -572,6 +841,13 @@
|
|
|
572
841
|
"$ref": "#/components/schemas/AudioAsset"
|
|
573
842
|
}
|
|
574
843
|
]
|
|
844
|
+
},
|
|
845
|
+
"length": {
|
|
846
|
+
"description": "The length, in seconds, of the clip the asset fills. A model that generates to a duration takes it from this value in place of its own duration option. Other models ignore it.",
|
|
847
|
+
"type": "number",
|
|
848
|
+
"minimum": 0,
|
|
849
|
+
"exclusiveMinimum": true,
|
|
850
|
+
"example": 5
|
|
575
851
|
}
|
|
576
852
|
},
|
|
577
853
|
"required": [
|
|
@@ -599,17 +875,35 @@
|
|
|
599
875
|
"content": {
|
|
600
876
|
"application/json": {
|
|
601
877
|
"schema": {
|
|
602
|
-
"$ref": "#/
|
|
878
|
+
"$ref": "#/components/schemas/GenerationResponse"
|
|
603
879
|
}
|
|
604
880
|
}
|
|
605
881
|
}
|
|
606
882
|
},
|
|
607
883
|
"202": {
|
|
608
884
|
"description": "The generation job is still processing.",
|
|
885
|
+
"headers": {
|
|
886
|
+
"Retry-After": {
|
|
887
|
+
"description": "Suggested seconds to wait before polling again.",
|
|
888
|
+
"schema": {
|
|
889
|
+
"type": "integer"
|
|
890
|
+
}
|
|
891
|
+
}
|
|
892
|
+
},
|
|
893
|
+
"content": {
|
|
894
|
+
"application/json": {
|
|
895
|
+
"schema": {
|
|
896
|
+
"$ref": "#/components/schemas/GenerationResponse"
|
|
897
|
+
}
|
|
898
|
+
}
|
|
899
|
+
}
|
|
900
|
+
},
|
|
901
|
+
"404": {
|
|
902
|
+
"description": "No generation job with this id exists for the calling account.",
|
|
609
903
|
"content": {
|
|
610
904
|
"application/json": {
|
|
611
905
|
"schema": {
|
|
612
|
-
"$ref": "#/
|
|
906
|
+
"$ref": "#/components/schemas/GenerationErrorResponse"
|
|
613
907
|
}
|
|
614
908
|
}
|
|
615
909
|
}
|
|
@@ -650,20 +944,7 @@
|
|
|
650
944
|
"content": {
|
|
651
945
|
"application/json": {
|
|
652
946
|
"schema": {
|
|
653
|
-
"
|
|
654
|
-
"properties": {
|
|
655
|
-
"models": {
|
|
656
|
-
"description": "The available models.",
|
|
657
|
-
"type": "array",
|
|
658
|
-
"items": {
|
|
659
|
-
"$ref": "#/paths/~1models~1%7Bid%7D/get/responses/200/content/application~1json/schema"
|
|
660
|
-
}
|
|
661
|
-
}
|
|
662
|
-
},
|
|
663
|
-
"required": [
|
|
664
|
-
"models"
|
|
665
|
-
],
|
|
666
|
-
"type": "object"
|
|
947
|
+
"$ref": "#/components/schemas/GenerationModelListResponse"
|
|
667
948
|
}
|
|
668
949
|
}
|
|
669
950
|
}
|
|
@@ -705,162 +986,20 @@
|
|
|
705
986
|
"content": {
|
|
706
987
|
"application/json": {
|
|
707
988
|
"schema": {
|
|
708
|
-
"
|
|
709
|
-
"properties": {
|
|
710
|
-
"model": {
|
|
711
|
-
"description": "The identifier to set as the asset `model`. Carries no provider name, so routing can change without a public rename.",
|
|
712
|
-
"type": "string",
|
|
713
|
-
"example": "seedance-2.0-text-to-video"
|
|
714
|
-
},
|
|
715
|
-
"type": {
|
|
716
|
-
"description": "The asset type this model generates.",
|
|
717
|
-
"type": "string",
|
|
718
|
-
"enum": [
|
|
719
|
-
"image",
|
|
720
|
-
"video",
|
|
721
|
-
"audio"
|
|
722
|
-
],
|
|
723
|
-
"example": "video"
|
|
724
|
-
},
|
|
725
|
-
"name": {
|
|
726
|
-
"description": "The model's display name, for a model picker.",
|
|
727
|
-
"type": "string",
|
|
728
|
-
"example": "Seedance 2.0 · Text to video"
|
|
729
|
-
},
|
|
730
|
-
"description": {
|
|
731
|
-
"description": "What the model is suited to, in a sentence or two.",
|
|
732
|
-
"type": "string",
|
|
733
|
-
"example": "Generate cinematic video with realistic motion, prompt-directed camera movement and optional synchronised audio."
|
|
734
|
-
},
|
|
735
|
-
"pricing": {
|
|
736
|
-
"description": "What one generation with this model costs.",
|
|
737
|
-
"properties": {
|
|
738
|
-
"credits": {
|
|
739
|
-
"description": "Credits per unit. A number when the rate is flat, or an object keyed by the values of the option named in `tieredBy`.",
|
|
740
|
-
"oneOf": [
|
|
741
|
-
{
|
|
742
|
-
"type": "number"
|
|
743
|
-
},
|
|
744
|
-
{
|
|
745
|
-
"type": "object",
|
|
746
|
-
"additionalProperties": true
|
|
747
|
-
}
|
|
748
|
-
],
|
|
749
|
-
"example": {
|
|
750
|
-
"480p": 0.9375,
|
|
751
|
-
"720p": 1.8962,
|
|
752
|
-
"1080p": 4.2625
|
|
753
|
-
}
|
|
754
|
-
},
|
|
755
|
-
"tieredBy": {
|
|
756
|
-
"description": "The option whose value selects the rate, and the value assumed when the option is absent. Present only when `credits` is keyed.",
|
|
757
|
-
"type": "object",
|
|
758
|
-
"properties": {
|
|
759
|
-
"option": {
|
|
760
|
-
"type": "string",
|
|
761
|
-
"example": "resolution"
|
|
762
|
-
},
|
|
763
|
-
"default": {
|
|
764
|
-
"type": "string",
|
|
765
|
-
"example": "720p"
|
|
766
|
-
}
|
|
767
|
-
},
|
|
768
|
-
"required": [
|
|
769
|
-
"option",
|
|
770
|
-
"default"
|
|
771
|
-
]
|
|
772
|
-
},
|
|
773
|
-
"quantity": {
|
|
774
|
-
"description": "How many units a generation consumes. Take the value `measure` names, or `default` when the request carries none, hold it within `min` and `max`, divide by `per`, and round up when `round` is `up`. Absent when one generation is one unit.",
|
|
775
|
-
"type": "object",
|
|
776
|
-
"properties": {
|
|
777
|
-
"measure": {
|
|
778
|
-
"description": "What the count is taken from, and the scale it is measured in.",
|
|
779
|
-
"type": "string",
|
|
780
|
-
"enum": [
|
|
781
|
-
"clipSeconds",
|
|
782
|
-
"promptCharacters"
|
|
783
|
-
],
|
|
784
|
-
"example": "clipSeconds"
|
|
785
|
-
},
|
|
786
|
-
"per": {
|
|
787
|
-
"description": "How many of `measure` make one billable unit.",
|
|
788
|
-
"type": "number",
|
|
789
|
-
"example": 60
|
|
790
|
-
},
|
|
791
|
-
"min": {
|
|
792
|
-
"description": "Fewest accepted. A smaller request is charged at this.",
|
|
793
|
-
"type": "number",
|
|
794
|
-
"example": 3
|
|
795
|
-
},
|
|
796
|
-
"max": {
|
|
797
|
-
"description": "Most accepted. A larger request is charged at this.",
|
|
798
|
-
"type": "number",
|
|
799
|
-
"example": 600
|
|
800
|
-
},
|
|
801
|
-
"default": {
|
|
802
|
-
"description": "Assumed when the request carries no value.",
|
|
803
|
-
"type": "number",
|
|
804
|
-
"example": 30
|
|
805
|
-
},
|
|
806
|
-
"round": {
|
|
807
|
-
"description": "Present when a partial unit is charged as a whole one. A 61 second track on a per-minute rate is charged as two minutes.",
|
|
808
|
-
"type": "string",
|
|
809
|
-
"enum": [
|
|
810
|
-
"up"
|
|
811
|
-
],
|
|
812
|
-
"example": "up"
|
|
813
|
-
}
|
|
814
|
-
},
|
|
815
|
-
"required": [
|
|
816
|
-
"measure",
|
|
817
|
-
"per"
|
|
818
|
-
]
|
|
819
|
-
},
|
|
820
|
-
"effectiveFrom": {
|
|
821
|
-
"description": "The date this rate took effect, or `legacy` for a rate that predates dated pricing.",
|
|
822
|
-
"type": "string",
|
|
823
|
-
"example": "2026-08-13"
|
|
824
|
-
}
|
|
825
|
-
},
|
|
826
|
-
"required": [
|
|
827
|
-
"credits",
|
|
828
|
-
"effectiveFrom"
|
|
829
|
-
],
|
|
830
|
-
"type": "object"
|
|
831
|
-
},
|
|
832
|
-
"options": {
|
|
833
|
-
"description": "JSON Schema for the model's `options` object. Only returned for a single model, or for a list requested with `expand=options`. Values outside this schema are rejected.",
|
|
834
|
-
"type": "object",
|
|
835
|
-
"additionalProperties": true
|
|
836
|
-
},
|
|
837
|
-
"available": {
|
|
838
|
-
"description": "Whether the account behind the calling API key can generate with this model. Omitted when that cannot be determined; treat a missing value as unknown, not as available. Generation requests are checked either way.",
|
|
839
|
-
"type": "boolean",
|
|
840
|
-
"example": false
|
|
841
|
-
},
|
|
842
|
-
"unavailableReason": {
|
|
843
|
-
"description": "Why `available` is false. `AiCapabilityNotIncluded`: the account's plan does not include this kind of generation. `AiDisabled`: AI generation is turned off for the account. `AiAccessUnavailable`: access could not be confirmed; try again later.",
|
|
844
|
-
"type": "string",
|
|
845
|
-
"enum": [
|
|
846
|
-
"AiCapabilityNotIncluded",
|
|
847
|
-
"AiDisabled",
|
|
848
|
-
"AiAccessUnavailable"
|
|
849
|
-
],
|
|
850
|
-
"example": "AiCapabilityNotIncluded"
|
|
851
|
-
}
|
|
852
|
-
},
|
|
853
|
-
"required": [
|
|
854
|
-
"model",
|
|
855
|
-
"type"
|
|
856
|
-
],
|
|
857
|
-
"type": "object"
|
|
989
|
+
"$ref": "#/components/schemas/GenerationModel"
|
|
858
990
|
}
|
|
859
991
|
}
|
|
860
992
|
}
|
|
861
993
|
},
|
|
862
994
|
"404": {
|
|
863
|
-
"description": "No model
|
|
995
|
+
"description": "No listed model has that identifier. `error.name` tells an unknown model from one that has been withdrawn.",
|
|
996
|
+
"content": {
|
|
997
|
+
"application/json": {
|
|
998
|
+
"schema": {
|
|
999
|
+
"$ref": "#/components/schemas/GenerationModelErrorResponse"
|
|
1000
|
+
}
|
|
1001
|
+
}
|
|
1002
|
+
}
|
|
864
1003
|
}
|
|
865
1004
|
},
|
|
866
1005
|
"security": [
|
|
@@ -990,6 +1129,15 @@
|
|
|
990
1129
|
"description": "Fetch an asset from a URL and send it to one or more destinations.",
|
|
991
1130
|
"content": {
|
|
992
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
|
+
},
|
|
993
1141
|
"schema": {
|
|
994
1142
|
"$ref": "#/components/schemas/Transfer"
|
|
995
1143
|
}
|
|
@@ -1735,7 +1883,7 @@
|
|
|
1735
1883
|
"model": {
|
|
1736
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.",
|
|
1737
1885
|
"type": "string",
|
|
1738
|
-
"example": "
|
|
1886
|
+
"example": "nano-banana-2"
|
|
1739
1887
|
},
|
|
1740
1888
|
"options": {
|
|
1741
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.",
|
|
@@ -4952,6 +5100,271 @@
|
|
|
4952
5100
|
],
|
|
4953
5101
|
"type": "object"
|
|
4954
5102
|
},
|
|
5103
|
+
"GenerationModel": {
|
|
5104
|
+
"description": "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.",
|
|
5105
|
+
"properties": {
|
|
5106
|
+
"model": {
|
|
5107
|
+
"description": "The identifier to set as the asset `model`. Carries no provider name, so routing can change without a public rename.",
|
|
5108
|
+
"type": "string",
|
|
5109
|
+
"example": "seedance-2.0-text-to-video"
|
|
5110
|
+
},
|
|
5111
|
+
"type": {
|
|
5112
|
+
"description": "The asset type this model generates.",
|
|
5113
|
+
"type": "string",
|
|
5114
|
+
"enum": [
|
|
5115
|
+
"image",
|
|
5116
|
+
"video",
|
|
5117
|
+
"audio"
|
|
5118
|
+
],
|
|
5119
|
+
"example": "video"
|
|
5120
|
+
},
|
|
5121
|
+
"name": {
|
|
5122
|
+
"description": "The model's display name, for a model picker.",
|
|
5123
|
+
"type": "string",
|
|
5124
|
+
"example": "Seedance 2.0 · Text to video"
|
|
5125
|
+
},
|
|
5126
|
+
"description": {
|
|
5127
|
+
"description": "What the model is suited to, in a sentence or two.",
|
|
5128
|
+
"type": "string",
|
|
5129
|
+
"example": "Generate cinematic video with realistic motion, prompt-directed camera movement and optional synchronised audio."
|
|
5130
|
+
},
|
|
5131
|
+
"pricing": {
|
|
5132
|
+
"description": "What one generation with this model costs.",
|
|
5133
|
+
"$ref": "#/components/schemas/GenerationModelPricing"
|
|
5134
|
+
},
|
|
5135
|
+
"options": {
|
|
5136
|
+
"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.",
|
|
5137
|
+
"type": "object",
|
|
5138
|
+
"additionalProperties": true
|
|
5139
|
+
},
|
|
5140
|
+
"available": {
|
|
5141
|
+
"description": "Whether the account behind the calling API key can generate with this model. Omitted when that cannot be determined; treat a missing value as unknown, not as available. Generation requests are checked either way.",
|
|
5142
|
+
"type": "boolean",
|
|
5143
|
+
"example": false
|
|
5144
|
+
},
|
|
5145
|
+
"unavailableReason": {
|
|
5146
|
+
"description": "Why `available` is false. `AiCapabilityNotIncluded`: the account's plan does not include this kind of generation. `AiDisabled`: AI generation is turned off for the account. `AiAccessUnavailable`: access could not be confirmed; try again later.",
|
|
5147
|
+
"type": "string",
|
|
5148
|
+
"enum": [
|
|
5149
|
+
"AiCapabilityNotIncluded",
|
|
5150
|
+
"AiDisabled",
|
|
5151
|
+
"AiAccessUnavailable"
|
|
5152
|
+
],
|
|
5153
|
+
"example": "AiCapabilityNotIncluded"
|
|
5154
|
+
}
|
|
5155
|
+
},
|
|
5156
|
+
"required": [
|
|
5157
|
+
"model",
|
|
5158
|
+
"type"
|
|
5159
|
+
],
|
|
5160
|
+
"type": "object"
|
|
5161
|
+
},
|
|
5162
|
+
"GenerationModelPricing": {
|
|
5163
|
+
"description": "What one generation costs, in credits: the rate multiplied by the units consumed. `quantity` says how to count the units, and is absent when one generation is one unit. Where a model charges differently per option value, `credits` is an object keyed by that value and `tieredBy` names the option that selects it.",
|
|
5164
|
+
"properties": {
|
|
5165
|
+
"credits": {
|
|
5166
|
+
"description": "Credits per unit. A number when the rate is flat, or an object keyed by the values of the option named in `tieredBy`.",
|
|
5167
|
+
"oneOf": [
|
|
5168
|
+
{
|
|
5169
|
+
"type": "number"
|
|
5170
|
+
},
|
|
5171
|
+
{
|
|
5172
|
+
"type": "object",
|
|
5173
|
+
"additionalProperties": {
|
|
5174
|
+
"type": "number"
|
|
5175
|
+
}
|
|
5176
|
+
}
|
|
5177
|
+
],
|
|
5178
|
+
"example": {
|
|
5179
|
+
"480p": 0.9375,
|
|
5180
|
+
"720p": 1.8962,
|
|
5181
|
+
"1080p": 4.2625
|
|
5182
|
+
}
|
|
5183
|
+
},
|
|
5184
|
+
"tieredBy": {
|
|
5185
|
+
"description": "The option whose value selects the rate, and the value assumed when the option is absent. Present only when `credits` is keyed.",
|
|
5186
|
+
"type": "object",
|
|
5187
|
+
"properties": {
|
|
5188
|
+
"option": {
|
|
5189
|
+
"type": "string",
|
|
5190
|
+
"example": "resolution"
|
|
5191
|
+
},
|
|
5192
|
+
"default": {
|
|
5193
|
+
"type": "string",
|
|
5194
|
+
"example": "720p"
|
|
5195
|
+
}
|
|
5196
|
+
},
|
|
5197
|
+
"required": [
|
|
5198
|
+
"option",
|
|
5199
|
+
"default"
|
|
5200
|
+
]
|
|
5201
|
+
},
|
|
5202
|
+
"quantity": {
|
|
5203
|
+
"description": "How many units a generation consumes. Take the value `measure` names, or `default` when the request carries none, hold it within `min` and `max`, divide by `per`, and round up when `round` is `up`. Absent when one generation is one unit.",
|
|
5204
|
+
"type": "object",
|
|
5205
|
+
"properties": {
|
|
5206
|
+
"measure": {
|
|
5207
|
+
"description": "What the count is taken from, and the scale it is measured in.",
|
|
5208
|
+
"type": "string",
|
|
5209
|
+
"enum": [
|
|
5210
|
+
"clipSeconds",
|
|
5211
|
+
"promptCharacters"
|
|
5212
|
+
],
|
|
5213
|
+
"example": "clipSeconds"
|
|
5214
|
+
},
|
|
5215
|
+
"per": {
|
|
5216
|
+
"description": "How many of `measure` make one billable unit.",
|
|
5217
|
+
"type": "number",
|
|
5218
|
+
"example": 60
|
|
5219
|
+
},
|
|
5220
|
+
"min": {
|
|
5221
|
+
"description": "Fewest accepted. A smaller request is charged at this.",
|
|
5222
|
+
"type": "number",
|
|
5223
|
+
"example": 3
|
|
5224
|
+
},
|
|
5225
|
+
"max": {
|
|
5226
|
+
"description": "Most accepted. A larger request is charged at this.",
|
|
5227
|
+
"type": "number",
|
|
5228
|
+
"example": 600
|
|
5229
|
+
},
|
|
5230
|
+
"default": {
|
|
5231
|
+
"description": "Assumed when the request carries no value.",
|
|
5232
|
+
"type": "number",
|
|
5233
|
+
"example": 30
|
|
5234
|
+
},
|
|
5235
|
+
"round": {
|
|
5236
|
+
"description": "Present when a partial unit is charged as a whole one. A 61 second track on a per-minute rate is charged as two minutes.",
|
|
5237
|
+
"type": "string",
|
|
5238
|
+
"enum": [
|
|
5239
|
+
"up"
|
|
5240
|
+
],
|
|
5241
|
+
"example": "up"
|
|
5242
|
+
}
|
|
5243
|
+
},
|
|
5244
|
+
"required": [
|
|
5245
|
+
"measure",
|
|
5246
|
+
"per"
|
|
5247
|
+
]
|
|
5248
|
+
},
|
|
5249
|
+
"effectiveFrom": {
|
|
5250
|
+
"description": "The date this rate took effect, or `legacy` for a rate that predates dated pricing.",
|
|
5251
|
+
"type": "string",
|
|
5252
|
+
"example": "2026-08-13"
|
|
5253
|
+
}
|
|
5254
|
+
},
|
|
5255
|
+
"required": [
|
|
5256
|
+
"credits",
|
|
5257
|
+
"effectiveFrom"
|
|
5258
|
+
],
|
|
5259
|
+
"type": "object"
|
|
5260
|
+
},
|
|
5261
|
+
"GenerationModelListResponse": {
|
|
5262
|
+
"description": "The generation models available to this account.",
|
|
5263
|
+
"properties": {
|
|
5264
|
+
"models": {
|
|
5265
|
+
"description": "The available models.",
|
|
5266
|
+
"type": "array",
|
|
5267
|
+
"items": {
|
|
5268
|
+
"$ref": "#/components/schemas/GenerationModel"
|
|
5269
|
+
}
|
|
5270
|
+
}
|
|
5271
|
+
},
|
|
5272
|
+
"required": [
|
|
5273
|
+
"models"
|
|
5274
|
+
],
|
|
5275
|
+
"type": "object"
|
|
5276
|
+
},
|
|
5277
|
+
"GenerationResponse": {
|
|
5278
|
+
"description": "The status of an on-demand asset generation job. Completed jobs include the public URL of the generated asset.",
|
|
5279
|
+
"type": "object",
|
|
5280
|
+
"properties": {
|
|
5281
|
+
"id": {
|
|
5282
|
+
"description": "The generation job id. Deterministic for a given owner and asset payload (or idempotency key), so identical requests return the same job and cached result.",
|
|
5283
|
+
"type": "string",
|
|
5284
|
+
"example": "8a1f2c3d-4e5b-5a6c-9d7e-1f2a3b4c5d6e"
|
|
5285
|
+
},
|
|
5286
|
+
"status": {
|
|
5287
|
+
"description": "The status of the generation job.",
|
|
5288
|
+
"type": "string",
|
|
5289
|
+
"enum": [
|
|
5290
|
+
"queued",
|
|
5291
|
+
"processing",
|
|
5292
|
+
"done",
|
|
5293
|
+
"failed"
|
|
5294
|
+
],
|
|
5295
|
+
"example": "done"
|
|
5296
|
+
},
|
|
5297
|
+
"url": {
|
|
5298
|
+
"description": "The public URL of the generated asset. Present only when `status` is `done`.",
|
|
5299
|
+
"type": "string",
|
|
5300
|
+
"example": "https://shotstack-api-v1-output.s3-ap-southeast-2.amazonaws.com/owner/8a1f2c3d.png"
|
|
5301
|
+
},
|
|
5302
|
+
"error": {
|
|
5303
|
+
"description": "A human readable error message. Present only when `status` is `failed`.",
|
|
5304
|
+
"type": "string"
|
|
5305
|
+
}
|
|
5306
|
+
},
|
|
5307
|
+
"required": [
|
|
5308
|
+
"id",
|
|
5309
|
+
"status"
|
|
5310
|
+
]
|
|
5311
|
+
},
|
|
5312
|
+
"GenerationErrorResponse": {
|
|
5313
|
+
"description": "Why a generation request was not accepted or a job could not be found.",
|
|
5314
|
+
"type": "object",
|
|
5315
|
+
"properties": {
|
|
5316
|
+
"error": {
|
|
5317
|
+
"description": "A human readable error message.",
|
|
5318
|
+
"type": "string",
|
|
5319
|
+
"example": "Insufficient generation credits."
|
|
5320
|
+
},
|
|
5321
|
+
"code": {
|
|
5322
|
+
"description": "Why access to AI generation was refused. `AiCapabilityNotIncluded`: the account's plan does not include this kind of generation. `FeatureNotIncluded`: the plan does not include a feature the asset uses. `AiDisabled`: AI generation is turned off for the account. `AiAccessUnavailable`: access could not be confirmed; try again later.",
|
|
5323
|
+
"type": "string",
|
|
5324
|
+
"example": "AiCapabilityNotIncluded"
|
|
5325
|
+
},
|
|
5326
|
+
"available": {
|
|
5327
|
+
"description": "The credits the account has available. Present when it has too few.",
|
|
5328
|
+
"type": "number",
|
|
5329
|
+
"example": 1.5
|
|
5330
|
+
}
|
|
5331
|
+
},
|
|
5332
|
+
"required": [
|
|
5333
|
+
"error"
|
|
5334
|
+
]
|
|
5335
|
+
},
|
|
5336
|
+
"GenerationModelErrorResponse": {
|
|
5337
|
+
"description": "Why a generation model could not be returned.",
|
|
5338
|
+
"type": "object",
|
|
5339
|
+
"properties": {
|
|
5340
|
+
"error": {
|
|
5341
|
+
"type": "object",
|
|
5342
|
+
"properties": {
|
|
5343
|
+
"name": {
|
|
5344
|
+
"description": "`UnknownGenerationModel`: no model has this identifier. `WithdrawnGenerationModel`: the model is no longer listed, but edits that already use it still validate, bill and render.",
|
|
5345
|
+
"type": "string",
|
|
5346
|
+
"enum": [
|
|
5347
|
+
"UnknownGenerationModel",
|
|
5348
|
+
"WithdrawnGenerationModel"
|
|
5349
|
+
],
|
|
5350
|
+
"example": "UnknownGenerationModel"
|
|
5351
|
+
},
|
|
5352
|
+
"message": {
|
|
5353
|
+
"description": "A human readable error message.",
|
|
5354
|
+
"type": "string",
|
|
5355
|
+
"example": "Unknown generation model \"seedance-9\"."
|
|
5356
|
+
}
|
|
5357
|
+
},
|
|
5358
|
+
"required": [
|
|
5359
|
+
"name",
|
|
5360
|
+
"message"
|
|
5361
|
+
]
|
|
5362
|
+
}
|
|
5363
|
+
},
|
|
5364
|
+
"required": [
|
|
5365
|
+
"error"
|
|
5366
|
+
]
|
|
5367
|
+
},
|
|
4955
5368
|
"QueuedResponse": {
|
|
4956
5369
|
"description": "The response received after a [render request](#render-asset) or [template render](#render-template) is submitted. The render task is queued for rendering and a unique render id is returned.",
|
|
4957
5370
|
"properties": {
|
|
@@ -5201,7 +5614,94 @@
|
|
|
5201
5614
|
"description": "The [Edit](#tocs_edit) template.",
|
|
5202
5615
|
"$ref": "#/components/schemas/Edit",
|
|
5203
5616
|
"example": {
|
|
5204
|
-
"
|
|
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
|
+
}
|
|
5205
5705
|
}
|
|
5206
5706
|
}
|
|
5207
5707
|
},
|