Get the rendering status, temporary asset url and details of a render by ID.
base URL:
643 matches
Other/Shotstack
Get Render Status
v1.0.0Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
- 316
- 317
- 318
- 319
- 320
- 321
- 322
- 323
- 324
- 325
- 326
- 327
- 328
- 329
- 330
- 331
- 332
- 333
- 334
- 335
- 336
- 337
- 338
- 339
- 340
- 341
- 342
- 343
- 344
- 345
- 346
- 347
- 348
- 349
- 350
- 351
- 352
- 353
- 354
- 355
- 356
- 357
- 358
- 359
- 360
- 361
- 362
- 363
- 364
- 365
- 366
- 367
- 368
- 369
- 370
- 371
- 372
- 373
- 374
- 375
- 376
- 377
- 378
- 379
- 380
- 381
- 382
- 383
- 384
- 385
{
"type": "object",
"description": "The response received after a [render status request](#get-render-status) is submitted. The response includes details about status of a render and the output URL.",
"required": [
"message",
"response",
"success"
],
"properties": {
"message": {
"type": "string",
"description": "`OK` or an error message."
},
"response": {
"type": "object",
"description": "`RenderResponse` or an error message.",
"required": [
"created",
"data",
"id",
"owner",
"status",
"updated"
],
"properties": {
"created": {
"type": "string",
"description": "The time the render task was initially queued."
},
"data": {
"type": "object",
"description": "An edit defines the arrangement of a video on a timeline, an audio edit or an image design and the output format.",
"required": [
"output",
"timeline"
],
"properties": {
"callback": {
"type": "string",
"description": "An optional webhook callback URL used to receive status notifications when a render completes or fails. See [webhooks](https://shotstack.gitbook.io/docs/guides/architecting-an-application/webhooks) for more details."
},
"disk": {
"type": "string",
"description": "The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.gitbook.io/docs/guides/architecting-an-application/disk-types) for more details. <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>",
"enum": [
"local",
"mount"
]
},
"output": {
"type": "object",
"description": "The output format, render range and type of media to generate.",
"required": [
"format"
],
"properties": {
"aspectRatio": {
"type": "string",
"description": "The aspect ratio (shape) of the video or image. Useful for social media output formats. Options are: <ul>\n <li>`16:9` - regular landscape/horizontal aspect ratio (default)</li>\n <li>`9:16` - vertical/portrait aspect ratio</li>\n <li>`1:1` - square aspect ratio</li>\n <li>`4:5` - short vertical/portrait aspect ratio</li>\n <li>`4:3` - legacy TV aspect ratio</li>\n</ul>",
"enum": [
"16:9",
"9:16",
"1:1",
"4:5",
"4:3"
]
},
"destinations": {
"type": "array",
"description": "A destination is a location where output files can be sent to for serving or hosting. By default all rendered assets are automatically sent to the Shotstack hosting destination. [DestinationShotstack](/#tocs_shotstackdestination) is currently the only option with plans to add more in the future such as S3, YouTube, Vimeo and Mux. If you do not require hosting you can opt-out using the `exclude` property.",
"items": {
"type": "object"
}
},
"format": {
"type": "string",
"description": "The output format and type of media file to generate. <ul>\n <li>`mp4` - mp4 video file</li>\n <li>`gif` - animated gif</li>\n <li>`jpg` - jpg image file</li>\n <li>`png` - png image file</li>\n <li>`bmp` - bmp image file</li>\n <li>`mp3` - mp3 audio file (audio only)</li>\n</ul>",
"enum": [
"mp4",
"gif",
"mp3",
"jpg",
"png",
"bmp"
]
},
"fps": {
"type": "integer",
"description": "Override the default frames per second. Useful for when the source footage is recorded at 30fps, i.e. on mobile devices. Lower frame rates can be used to add cinematic quality (24fps) or to create smaller file size/faster render times or animated gifs (12 or 15fps). Default is 25fps. <ul>\n <li>`12` - 12fps</li>\n <li>`15` - 15fps</li>\n <li>`24` - 24fps</li>\n <li>`25` - 25fps</li>\n <li>`30` - 30fps</li>\n</ul>",
"enum": [
12,
15,
24,
25,
30
]
},
"poster": {
"type": "object",
"description": "Generate a poster image from a specific point on the timeline.",
"required": [
"capture"
],
"properties": {
"capture": {
"type": "number",
"description": "The point on the timeline in seconds to capture a single frame to use as the poster image."
}
}
},
"quality": {
"type": "string",
"description": "Adjust the output quality of the video, image or audio. Adjusting quality affects render speed, download speeds and storage requirements due to file size. The default `medium` provides the most optimized choice for all three factors. <ul>\n <li>`low` - slightly reduced quality, smaller file size</li>\n <li>`medium` - optimized quality, render speeds and file size</li>\n <li>`high` - slightly increased quality, larger file size</li>\n</ul>",
"enum": [
"low",
"medium",
"high"
]
},
"range": {
"type": "object",
"description": "Specify a time range to render, i.e. to render only a portion of a video or audio file. Omit this setting to export the entire video. Range can also be used to render a frame at a specific time point - setting a range and output format as `jpg` will output a single frame image at the range `start` point.",
"properties": {
"length": {
"type": "number",
"format": "float",
"description": "The length of the portion of the video or audio to render - i.e. render 6 seconds of the video."
},
"start": {
"type": "number",
"format": "float",
"description": "The point on the timeline, in seconds, to start the render from - i.e. start at second 3."
}
}
},
"resolution": {
"type": "string",
"description": "The output resolution of the video or image. <ul>\n <li>`preview` - 512px x 288px @ 15fps</li>\n <li>`mobile` - 640px x 360px @ 25fps</li>\n <li>`sd` - 1024px x 576px @ 25fps</li>\n <li>`hd` - 1280px x 720px @ 25fps</li>\n <li>`1080` - 1920px x 1080px @ 25fps</li>\n</ul>",
"enum": [
"preview",
"mobile",
"sd",
"hd",
"1080"
]
},
"scaleTo": {
"type": "string",
"description": "Override the resolution and scale the video or image to render at a different size. When using scaleTo the asset should be edited at the resolution dimensions, i.e. use font sizes that look best at HD, then use scaleTo to output the file at SD and the text will be scaled to the correct size. This is useful if you want to create multiple asset sizes. <ul>\n <li>`preview` - 512px x 288px @ 15fps</li>\n <li>`mobile` - 640px x 360px @ 25fps</li>\n <li>`sd` - 1024px x 576px @25fps</li>\n <li>`hd` - 1280px x 720px @25fps</li>\n <li>`1080` - 1920px x 1080px @25fps</li>\n</ul>",
"enum": [
"preview",
"mobile",
"sd",
"hd",
"1080"
]
},
"size": {
"type": "object",
"description": "Set a custom size for a video or image. When using a custom size omit the `resolution` and `aspectRatio`. Custom sizes must be divisible by 2 based on the encoder specifications.",
"properties": {
"height": {
"type": "integer",
"description": "Set a custom height for the video or image file. Value must be divisible by 2. Maximum video height is 1920px, maximum image height is 4096px."
},
"width": {
"type": "integer",
"description": "Set a custom width for the video or image file. Value must be divisible by 2. Maximum video width is 1920px, maximum image width is 4096px."
}
}
},
"thumbnail": {
"type": "object",
"description": "Generate a thumbnail image from a specific point on the timeline.",
"required": [
"capture",
"scale"
],
"properties": {
"capture": {
"type": "number",
"description": "The point on the timeline in seconds to capture a single frame to use as the thumbnail image."
},
"scale": {
"type": "number",
"description": "Scale the thumbnail size to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale the thumbnail to half the size of the viewport."
}
}
}
}
},
"timeline": {
"type": "object",
"description": "A timeline represents the contents of a video edit over time, an audio edit over time, in seconds, or an image layout. A timeline consists of layers called tracks. Tracks are composed of titles, images, audio, html or video segments referred to as clips which are placed along the track at specific starting point and lasting for a specific amount of time.",
"required": [
"tracks"
],
"properties": {
"background": {
"type": "string",
"description": "A hexadecimal value for the timeline background colour. Defaults to #000000 (black)."
},
"cache": {
"type": "boolean",
"description": "Disable the caching of ingested source footage and assets. See [caching](https://shotstack.gitbook.io/docs/guides/architecting-an-application/caching) for more details."
},
"fonts": {
"type": "array",
"description": "An array of custom fonts to be downloaded for use by the HTML assets.",
"items": {
"type": "object",
"description": "Download a custom font to use with the HTML asset type, using the font name in the CSS or font tag. See our [custom fonts](https://shotstack.io/learn/html-custom-fonts/) getting started guide for more details.",
"required": [
"src"
],
"properties": {
"src": {
"type": "string",
"description": "The URL of the font file. The URL must be publicly accessible or include credentials."
}
}
}
},
"soundtrack": {
"type": "object",
"description": "A music or audio soundtrack file in mp3 format.",
"required": [
"src"
],
"properties": {
"effect": {
"type": "string",
"description": "The effect to apply to the audio file <ul>\n <li>`fadeIn` - fade volume in only</li>\n <li>`fadeOut` - fade volume out only</li>\n <li>`fadeInFadeOut` - fade volume in and out</li>\n</ul>",
"enum": [
"fadeIn",
"fadeOut",
"fadeInFadeOut"
]
},
"src": {
"type": "string",
"description": "The URL of the mp3 audio file. The URL must be publicly accessible or include credentials."
},
"volume": {
"type": "number",
"description": "Set the volume for the soundtrack between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1)."
}
}
},
"tracks": {
"type": "array",
"description": "A timeline consists of an array of tracks, each track containing clips. Tracks are layered on top of each other in the same order they are added to the array with the top most track layered over the top of those below it. Ensure that a track containing titles is the top most track so that it is displayed above videos and images.",
"items": {
"type": "object",
"description": "A track contains an array of clips. Tracks are layered on top of each other in the order in the array. The top most track will render on top of those below it.",
"required": [
"clips"
],
"properties": {
"clips": {
"type": "array",
"description": "An array of Clips comprising of TitleClip, ImageClip or VideoClip.",
"items": {
"type": "object",
"description": "A clip is a container for a specific type of asset, i.e. a title, image, video, audio or html. You use a Clip to define when an asset will display on the timeline, how long it will play for and transitions, filters and effects to apply to it.",
"required": [
"asset",
"start",
"length"
],
"properties": {
"asset": {
"type": "object",
"additionalProperties": true
},
"effect": {
"type": "object",
"additionalProperties": true
},
"filter": {
"type": "object",
"additionalProperties": true
},
"fit": {
"type": "object",
"additionalProperties": true
},
"length": {
"type": "object",
"additionalProperties": true
},
"offset": {
"type": "object",
"additionalProperties": true
},
"opacity": {
"type": "object",
"additionalProperties": true
},
"position": {
"type": "object",
"additionalProperties": true
},
"scale": {
"type": "object",
"additionalProperties": true
},
"start": {
"type": "object",
"additionalProperties": true
},
"transition": {
"type": "object",
"additionalProperties": true
}
}
}
}
}
}
}
}
}
}
},
"duration": {
"type": "number",
"description": "The output video or audio length in seconds."
},
"error": {
"type": "string",
"description": "An error message, only displayed if an error occurred."
},
"id": {
"type": "string",
"description": "The id of the render task in UUID format."
},
"owner": {
"type": "string",
"description": "The owner id of the render task."
},
"plan": {
"type": "string",
"description": "The customer subscription plan."
},
"poster": {
"type": "string",
"description": "The URL of the poster image if requested. This will only be available if status is done."
},
"renderTime": {
"type": "number",
"description": "The time taken to render the asset in milliseconds."
},
"status": {
"type": "string",
"description": "The status of the render task. <ul>\n <li>`queued` - render is queued waiting to be rendered</li>\n <li>`fetching` - assets are being fetched</li>\n <li>`rendering` - the asset is being rendered</li>\n <li>`saving` - the final asset is being saved to storage</li>\n <li>`done` - the asset is ready to be downloaded</li>\n <li>`failed` - there was an error rendering the asset</li>\n</ul>",
"enum": [
"queued",
"fetching",
"rendering",
"saving",
"done",
"failed"
]
},
"thumbnail": {
"type": "string",
"description": "The URL of the thumbnail image if requested. This will only be available if status is done."
},
"updated": {
"type": "string",
"description": "The time the render status was last updated."
},
"url": {
"type": "string",
"description": "The URL of the final asset. This will only be available if status is done. This is a temporary URL and will be deleted after 24 hours. By default all assets are copied to the Shotstack hosting and CDN destination."
}
}
},
"success": {
"type": "boolean",
"description": "`true` if status available, else `false`."
}
}
}