{ "uuid": "830a6b04-8b6f-4366-96ee-98759d8c6dc0", "lastMigration": 29, "name": "Shotstack", "endpointPrefix": "v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "6cb6c349-56d1-4374-a12d-467cb36a5922", "documentation": "Get Asset by Render ID", "method": "get", "endpoint": "assets/render/:id", "responses": [ { "uuid": "41b261db-9908-44c1-b108-593879d3e42c", "body": "{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"2021-06-30T09:42:29.446Z\",\n \"filename\": \"2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7.mp4\",\n \"id\": \"a4482cbf-e321-42a2-ac8b-947d26886840\",\n \"owner\": \"5ca6hu7s9k\",\n \"region\": \"au\",\n \"renderId\": \"2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7\",\n \"status\": \"{{oneOf (array 'importing' 'ready' 'failed' 'deleted')}}\",\n \"updated\": \"2021-06-30T09:42:30.168Z\",\n \"url\": \"https://cdn.shotstack.io/au/v1/5ca6hu7s9k/2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7.mp4\"\n },\n \"type\": \"asset\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Get one or more assets by render id", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1d3063c5-4081-4888-8628-4e5219dca892", "documentation": "Delete Asset", "method": "delete", "endpoint": "assets/:id", "responses": [ { "uuid": "cb5eadd1-9728-4821-8c5f-2df6d0d8b0fd", "body": "", "latency": 0, "statusCode": 204, "label": "An empty response signifying the asset has been deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b1080584-903c-4c09-beeb-014e465467ed", "documentation": "Get Asset", "method": "get", "endpoint": "assets/:id", "responses": [ { "uuid": "1d7e2fb8-244c-4203-bb48-21ddbc499fed", "body": "{\n \"data\": {\n \"attributes\": {\n \"created\": \"2021-06-30T09:42:29.446Z\",\n \"filename\": \"2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7.mp4\",\n \"id\": \"a4482cbf-e321-42a2-ac8b-947d26886840\",\n \"owner\": \"5ca6hu7s9k\",\n \"region\": \"au\",\n \"renderId\": \"2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7\",\n \"status\": \"{{oneOf (array 'importing' 'ready' 'failed' 'deleted')}}\",\n \"updated\": \"2021-06-30T09:42:30.168Z\",\n \"url\": \"https://cdn.shotstack.io/au/v1/5ca6hu7s9k/2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7.mp4\"\n },\n \"type\": \"asset\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Get asset by asset id", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b4060dc9-fc4b-4800-b7b1-16fe80734d29", "documentation": "Render Asset", "method": "post", "endpoint": "render", "responses": [ { "uuid": "fddb90ff-7a2b-48d4-a1b4-a1a41807c7db", "body": "{\n \"message\": \"Created\",\n \"response\": {\n \"id\": \"2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7\",\n \"message\": \"Render Successfully Queued\"\n },\n \"success\": true\n}", "latency": 0, "statusCode": 201, "label": "The queued render details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bc3a92e6-edcc-4f5f-b73b-ea32082a68a5", "documentation": "Get Render Status", "method": "get", "endpoint": "render/:id", "responses": [ { "uuid": "eb04e300-834d-497c-8ca9-e7d0bf0ab011", "body": "{\n \"message\": \"OK\",\n \"response\": {\n \"created\": \"2020-10-30T09:42:29.446Z\",\n \"data\": {\n \"callback\": \"https://my-server.com/callback.php\",\n \"disk\": \"{{oneOf (array 'local' 'mount')}}\",\n \"output\": {\n \"aspectRatio\": \"{{oneOf (array '16:9' '9:16' '1:1' '4:5' '4:3')}}\",\n \"destinations\": [\n {\n \"exclude\": {{faker 'datatype.boolean'}},\n \"provider\": \"shotstack\"\n }\n ],\n \"format\": \"{{oneOf (array 'mp4' 'gif' 'mp3' 'jpg' 'png' 'bmp')}}\",\n \"fps\": \"{{oneOf (array '12' '15' '24' '25' '30')}}\",\n \"poster\": {\n \"capture\": 1\n },\n \"quality\": \"{{oneOf (array 'low' 'medium' 'high')}}\",\n \"range\": {\n \"length\": 6,\n \"start\": 3\n },\n \"resolution\": \"{{oneOf (array 'preview' 'mobile' 'sd' 'hd' '1080')}}\",\n \"scaleTo\": \"{{oneOf (array 'preview' 'mobile' 'sd' 'hd' '1080')}}\",\n \"size\": {\n \"height\": 800,\n \"width\": 1200\n },\n \"thumbnail\": {\n \"capture\": 1,\n \"scale\": 0.3\n }\n },\n \"timeline\": {\n \"background\": \"#000000\",\n \"cache\": true,\n \"fonts\": [\n {\n \"src\": \"https://s3-ap-northeast-1.amazonaws.com/my-bucket/open-sans.ttf\"\n }\n ],\n \"soundtrack\": {\n \"effect\": \"{{oneOf (array 'fadeIn' 'fadeOut' 'fadeInFadeOut')}}\",\n \"src\": \"https://s3-ap-northeast-1.amazonaws.com/my-bucket/music.mp3\",\n \"volume\": 1\n },\n \"tracks\": [\n {\n \"clips\": [\n {\n \"asset\": {\n \"crop\": {\n \"bottom\": 0.15,\n \"left\": {{faker 'number.float'}},\n \"right\": {{faker 'number.float'}},\n \"top\": 0.15\n },\n \"src\": \"https://s3-ap-northeast-1.amazonaws.com/my-bucket/video.mp4\",\n \"trim\": 2,\n \"type\": \"video\",\n \"volume\": 1\n },\n \"effect\": \"{{oneOf (array 'zoomIn' 'zoomOut' 'slideLeft' 'slideRight' 'slideUp' 'slideDown')}}\",\n \"filter\": \"{{oneOf (array 'boost' 'contrast' 'darken' 'greyscale' 'lighten' 'muted' 'negative')}}\",\n \"fit\": \"{{oneOf (array 'cover' 'contain' 'crop' 'none')}}\",\n \"length\": 5,\n \"offset\": {\n \"x\": 0.1,\n \"y\": -0.2\n },\n \"opacity\": 1,\n \"position\": \"{{oneOf (array 'top' 'topRight' 'right' 'bottomRight' 'bottom' 'bottomLeft' 'left' 'topLeft' 'center')}}\",\n \"scale\": {{faker 'number.int' max=99999}},\n \"start\": 2,\n \"transition\": {\n \"in\": \"{{oneOf (array 'fade' 'fadeSlow' 'fadeFast' 'reveal' 'revealSlow' 'revealFast' 'wipeLeft' 'wipeLeftSlow' 'wipeLeftFast' 'wipeRight' 'wipeRightSlow' 'wipeRightFast' 'slideLeft' 'slideLeftSlow' 'slideLeftFast' 'slideRight' 'slideRightSlow' 'slideRightFast' 'slideUp' 'slideUpSlow' 'slideUpFast' 'slideDown' 'slideDownSlow' 'slideDownFast' 'carouselLeft' 'carouselLeftSlow' 'carouselLeftFast' 'carouselRight' 'carouselRightSlow' 'carouselRightFast' 'carouselUp' 'carouselUpSlow' 'carouselUpFast' 'carouselDown' 'carouselDownSlow' 'carouselDownFast' 'shuffleTopRight' 'shuffleTopRightSlow' 'shuffleTopRightFast' 'shuffleRightTop' 'shuffleRightTopSlow' 'shuffleRightTopFast' 'shuffleRightBottom' 'shuffleRightBottomSlow' 'shuffleRightBottomFast' 'shuffleBottomRight' 'shuffleBottomRightSlow' 'shuffleBottomRightFast' 'shuffleBottomLeft' 'shuffleBottomLeftSlow' 'shuffleBottomLeftFast' 'shuffleLeftBottom' 'shuffleLeftBottomSlow' 'shuffleLeftBottomFast' 'shuffleLeftTop' 'shuffleLeftTopSlow' 'shuffleLeftTopFast' 'shuffleTopLeft' 'shuffleTopLeftSlow' 'shuffleTopLeftFast' 'zoom')}}\",\n \"out\": \"{{oneOf (array 'fade' 'fadeSlow' 'fadeFast' 'reveal' 'revealSlow' 'revealFast' 'wipeLeft' 'wipeLeftSlow' 'wipeLeftFast' 'wipeRight' 'wipeRightSlow' 'wipeRightFast' 'slideLeft' 'slideLeftSlow' 'slideLeftFast' 'slideRight' 'slideRightSlow' 'slideRightFast' 'slideUp' 'slideUpSlow' 'slideUpFast' 'slideDown' 'slideDownSlow' 'slideDownFast' 'carouselLeft' 'carouselLeftSlow' 'carouselLeftFast' 'carouselRight' 'carouselRightSlow' 'carouselRightFast' 'carouselUp' 'carouselUpSlow' 'carouselUpFast' 'carouselDown' 'carouselDownSlow' 'carouselDownFast' 'shuffleTopRight' 'shuffleTopRightSlow' 'shuffleTopRightFast' 'shuffleRightTop' 'shuffleRightTopSlow' 'shuffleRightTopFast' 'shuffleRightBottom' 'shuffleRightBottomSlow' 'shuffleRightBottomFast' 'shuffleBottomRight' 'shuffleBottomRightSlow' 'shuffleBottomRightFast' 'shuffleBottomLeft' 'shuffleBottomLeftSlow' 'shuffleBottomLeftFast' 'shuffleLeftBottom' 'shuffleLeftBottomSlow' 'shuffleLeftBottomFast' 'shuffleLeftTop' 'shuffleLeftTopSlow' 'shuffleLeftTopFast' 'shuffleTopLeft' 'shuffleTopLeftSlow' 'shuffleTopLeftFast' 'zoom')}}\"\n }\n }\n ]\n }\n ]\n }\n },\n \"duration\": 8.5,\n \"error\": \"\",\n \"id\": \"2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7\",\n \"owner\": \"5ca6hu7s9k\",\n \"plan\": \"basic\",\n \"poster\": \"https://shotstack-api-v1-output.s3-ap-southeast-2.amazonaws.com/5ca6hu7s9k/2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7-poster.jpg\",\n \"renderTime\": 9433.44,\n \"status\": \"{{oneOf (array 'queued' 'fetching' 'rendering' 'saving' 'done' 'failed')}}\",\n \"thumbnail\": \"https://shotstack-api-v1-output.s3-ap-southeast-2.amazonaws.com/5ca6hu7s9k/2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7-thumb.jpg\",\n \"updated\": \"2020-10-30T09:42:39.168Z\",\n \"url\": \"https://shotstack-api-v1-output.s3-ap-southeast-2.amazonaws.com/5ca6hu7s9k/2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7.mp4\"\n },\n \"success\": true\n}", "latency": 0, "statusCode": 200, "label": "The render status details", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "6cb6c349-56d1-4374-a12d-467cb36a5922" }, { "type": "route", "uuid": "1d3063c5-4081-4888-8628-4e5219dca892" }, { "type": "route", "uuid": "b1080584-903c-4c09-beeb-014e465467ed" }, { "type": "route", "uuid": "b4060dc9-fc4b-4800-b7b1-16fe80734d29" }, { "type": "route", "uuid": "bc3a92e6-edcc-4f5f-b73b-ea32082a68a5" } ] }