{ "item": [ { "id": "be5a8712-9c45-488d-9d84-1e4c47aef4e5", "name": "Health", "description": { "content": "Service health and diagnostics", "type": "text/plain" }, "item": [ { "id": "6fb7f56d-6265-40a7-b9a5-b5be291ff9fb", "name": "Public health check", "request": { "name": "Public health check", "description": {}, "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "440e8d70-0389-49be-97df-4e184f011ead", "name": "Service is up", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3a72282f-a58e-4a53-bdca-36c627b7acf0", "name": "Detailed health check", "request": { "name": "Detailed health check", "description": { "content": "Exposes Redis and Supabase latency metrics. Protected by API key.", "type": "text/plain" }, "url": { "path": [ "health", "detailed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c60f6ee6-95e4-4df7-a6ca-dcaaed833f39", "name": "Detailed health status", "originalRequest": { "url": { "path": [ "health", "detailed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"degraded\",\n \"timestamp\": \"1968-03-01T12:42:56.275Z\",\n \"services\": {\n \"redis\": {\n \"status\": \"ok\",\n \"latencyMs\": 9303,\n \"error\": \"string\"\n },\n \"supabase\": {\n \"status\": \"not_configured\",\n \"latencyMs\": 7902,\n \"error\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c047fa95-d05d-486b-aa05-57016b36f72f", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "health", "detailed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "254c71b2-fcae-4e14-8e70-3a6591aeb7f8", "name": "Render", "description": { "content": "Video rendering pipeline", "type": "text/plain" }, "item": [ { "id": "ec685c5e-776d-4858-a4e4-f56d0c9d0efc", "name": "Queue a render job", "request": { "name": "Queue a render job", "description": { "content": "Submit a `VideoJSON` payload to be rendered to MP4.", "type": "text/plain" }, "url": { "path": [ "v1", "render" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional idempotency key (max 128 chars, 24h replay window).", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"videoJSON\": {\n \"name\": \"\",\n \"layers\": [\n \"\"\n ],\n \"tracks\": [\n \"\",\n \"\"\n ],\n \"destinations\": [\n {\n \"integrationId\": \"\",\n \"provider\": \"\",\n \"pathPrefix\": \"\"\n },\n {\n \"integrationId\": \"\",\n \"provider\": \"\",\n \"pathPrefix\": \"\"\n }\n ]\n },\n \"webhookUrl\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "363a1174-2702-4987-b97b-e682e95c4b47", "name": "Job queued successfully", "originalRequest": { "url": { "path": [ "v1", "render" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Optional idempotency key (max 128 chars, 24h replay window).", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"videoJSON\": {\n \"name\": \"\",\n \"layers\": [\n \"\"\n ],\n \"tracks\": [\n \"\",\n \"\"\n ],\n \"destinations\": [\n {\n \"integrationId\": \"\",\n \"provider\": \"\",\n \"pathPrefix\": \"\"\n },\n {\n \"integrationId\": \"\",\n \"provider\": \"\",\n \"pathPrefix\": \"\"\n }\n ]\n },\n \"webhookUrl\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Present with value `true` when replayed from cache.", "key": "Idempotent-Replay", "value": "true" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"jobId\": \"81197f20-7d1d-dd0a-0091-3f416d590093\",\n \"status\": \"string\",\n \"stage\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc9cd403-a878-4994-9861-0fa03d3a402b", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "render" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Optional idempotency key (max 128 chars, 24h replay window).", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"videoJSON\": {\n \"name\": \"\",\n \"layers\": [\n \"\"\n ],\n \"tracks\": [\n \"\",\n \"\"\n ],\n \"destinations\": [\n {\n \"integrationId\": \"\",\n \"provider\": \"\",\n \"pathPrefix\": \"\"\n },\n {\n \"integrationId\": \"\",\n \"provider\": \"\",\n \"pathPrefix\": \"\"\n }\n ]\n },\n \"webhookUrl\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "196d80aa-58a9-4cbf-9e18-f8d9b5e3a646", "name": "Insufficient API credits", "originalRequest": { "url": { "path": [ "v1", "render" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Optional idempotency key (max 128 chars, 24h replay window).", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"videoJSON\": {\n \"name\": \"\",\n \"layers\": [\n \"\"\n ],\n \"tracks\": [\n \"\",\n \"\"\n ],\n \"destinations\": [\n {\n \"integrationId\": \"\",\n \"provider\": \"\",\n \"pathPrefix\": \"\"\n },\n {\n \"integrationId\": \"\",\n \"provider\": \"\",\n \"pathPrefix\": \"\"\n }\n ]\n },\n \"webhookUrl\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12ef787c-5576-43d3-9428-ecea9e578ae5", "name": "Too many active render jobs", "originalRequest": { "url": { "path": [ "v1", "render" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Optional idempotency key (max 128 chars, 24h replay window).", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"videoJSON\": {\n \"name\": \"\",\n \"layers\": [\n \"\"\n ],\n \"tracks\": [\n \"\",\n \"\"\n ],\n \"destinations\": [\n {\n \"integrationId\": \"\",\n \"provider\": \"\",\n \"pathPrefix\": \"\"\n },\n {\n \"integrationId\": \"\",\n \"provider\": \"\",\n \"pathPrefix\": \"\"\n }\n ]\n },\n \"webhookUrl\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8c73cd8c-0c37-41c5-8c64-94e8c189c10f", "name": "List recent renders", "request": { "name": "List recent renders", "description": {}, "url": { "path": [ "v1", "render" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "ae49cac7-df1d-4d7d-9f74-4ee713c6f7f2", "name": "Recent renders", "originalRequest": { "url": { "path": [ "v1", "render" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"974ea442-6caa-9b8b-86ca-a6d631b2dbeb\",\n \"status\": \"completed\",\n \"progress\": 22,\n \"createdAt\": \"1980-12-25T12:22:58.086Z\",\n \"stage\": \"string\",\n \"url\": \"https://SpQOcNBEB.gxvJHbKtqsZ\",\n \"error\": \"string\",\n \"completedAt\": \"1968-07-19T18:27:06.435Z\",\n \"spriteUrl\": \"https://oRXIMB.oiykaIgXhbidW7qPGcDvvSPlHdVQ1Egw3TuW6+5kCTvlUEo78SDs0HkdIts7rHG\",\n \"cost\": 8230.168609081074,\n \"duration\": 1370.8132329457744,\n \"width\": 7643,\n \"height\": 6614\n },\n {\n \"id\": \"9e9c0863-9968-bfd4-1360-ef180043db84\",\n \"status\": \"completed\",\n \"progress\": 32,\n \"createdAt\": \"1961-03-01T09:28:35.467Z\",\n \"stage\": \"string\",\n \"url\": \"http://sZxbKMWeoZh.fjkpn++f-E.fqE9wUINHGMhrqhN5tkL\",\n \"error\": \"string\",\n \"completedAt\": \"1957-03-24T16:32:27.854Z\",\n \"spriteUrl\": \"http://BWkktpiqHNlLOESQzsRTybvPF.tilJYpLt+uHQQnZqmI8OQ.DDOUYrHZKh2Hs1jdNnY6j6sqHzBvofQRZi\",\n \"cost\": 7788.994267461121,\n \"duration\": 1338.8233197707289,\n \"width\": 4149,\n \"height\": 2644\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de920454-c8d2-46c8-99e6-410634fb8b96", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "render" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86f330ab-7660-4015-a364-9878db31ba4e", "name": "Estimate render cost", "request": { "name": "Estimate render cost", "description": {}, "url": { "path": [ "v1", "render", "cost" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"videoJSON\": {\n \"name\": \"\",\n \"layers\": [\n \"\"\n ],\n \"tracks\": [\n \"\",\n \"\"\n ],\n \"destinations\": [\n {\n \"integrationId\": \"\",\n \"provider\": \"\",\n \"pathPrefix\": \"\"\n },\n {\n \"integrationId\": \"\",\n \"provider\": \"\",\n \"pathPrefix\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "96100d35-8c36-4129-a705-f05bdb6cc1ec", "name": "Cost estimate", "originalRequest": { "url": { "path": [ "v1", "render", "cost" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"videoJSON\": {\n \"name\": \"\",\n \"layers\": [\n \"\"\n ],\n \"tracks\": [\n \"\",\n \"\"\n ],\n \"destinations\": [\n {\n \"integrationId\": \"\",\n \"provider\": \"\",\n \"pathPrefix\": \"\"\n },\n {\n \"integrationId\": \"\",\n \"provider\": \"\",\n \"pathPrefix\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"cost\": 2,\n \"estimatedDuration\": 10,\n \"resolution\": {\n \"width\": 1920,\n \"height\": 1080,\n \"label\": \"1080p\"\n },\n \"fps\": 30\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df11944c-1162-4d36-8fc1-c4528807507c", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "render", "cost" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"videoJSON\": {\n \"name\": \"\",\n \"layers\": [\n \"\"\n ],\n \"tracks\": [\n \"\",\n \"\"\n ],\n \"destinations\": [\n {\n \"integrationId\": \"\",\n \"provider\": \"\",\n \"pathPrefix\": \"\"\n },\n {\n \"integrationId\": \"\",\n \"provider\": \"\",\n \"pathPrefix\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c81fdea6-159f-4836-b7d0-80ccaecd52d1", "name": "Get workspace render tier", "request": { "name": "Get workspace render tier", "description": {}, "url": { "path": [ "v1", "render", "tier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "dad3227c-ed42-4c80-a729-a51a491ddc8a", "name": "Tier details", "originalRequest": { "url": { "path": [ "v1", "render", "tier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tier\": \"pro\",\n \"credits\": {\n \"balance\": 87,\n \"monthly\": 100,\n \"max\": 100\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26b4c128-f27a-4b77-90ea-68f33c524d3a", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "render", "tier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f269d27b-9394-4afe-9fc1-59492ae24591", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "render", "tier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ed407a6d-5000-43a8-bdef-caac89c9bb54", "name": "Get render job status", "request": { "name": "Get render job status", "description": {}, "url": { "path": [ "v1", "render", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "dbfee954-36f7-4abe-afa2-f35f16bddf41", "name": "Job status", "originalRequest": { "url": { "path": [ "v1", "render", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"jobId\": \"c2613ab5-090c-41f9-3e5b-cd3e208181dd\",\n \"status\": \"completed\",\n \"stage\": \"completed\",\n \"outputKey\": \"string\",\n \"progress\": {\n \"done\": 3978,\n \"total\": 3564,\n \"percent\": 3860\n },\n \"url\": \"https://FeNaCCD.jzfczayVpYiVRGg0SqJTPRC-wQC7g,rZ94ZzOsjrKGSC8SLmDfPDNS0.VdXzxl1Iu-H0C\",\n \"outputs\": [\n {\n \"id\": \"112f0c7c-24dc-6d1c-5d05-be1024deac38\",\n \"integration_id\": \"75304519-e795-fa1c-5dd8-219b0286e7af\",\n \"provider\": \"string\",\n \"output_key\": \"string\",\n \"output_url\": \"https://aGGDoZBrdrAXGavluatwAesxDOE.xcjczopnaAamRv\",\n \"output_size_bytes\": 9664,\n \"status\": \"string\",\n \"error\": \"string\",\n \"created_at\": \"1990-03-02T04:48:54.368Z\",\n \"updated_at\": \"1962-04-30T18:29:57.290Z\"\n },\n {\n \"id\": \"a68bfb7a-f2bc-a88f-8dbe-da10170b0a77\",\n \"integration_id\": \"ba8228ed-e8e7-7800-a16e-80a2dee55428\",\n \"provider\": \"string\",\n \"output_key\": \"string\",\n \"output_url\": \"https://GduSttkvaXbWbclQOw.geWasd5M-LdgYhZTxjhHkM7\",\n \"output_size_bytes\": 7698,\n \"status\": \"string\",\n \"error\": \"string\",\n \"created_at\": \"1998-07-30T20:37:04.482Z\",\n \"updated_at\": \"1982-08-31T14:37:43.010Z\"\n }\n ],\n \"error\": \"string\",\n \"createdAt\": \"1977-10-02T09:18:28.791Z\",\n \"completedAt\": \"2021-11-19T11:45:16.195Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "910a6d17-22b2-4931-86fb-c96ed4047bce", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "render", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5cd2fdc9-7916-42bb-bbd1-95d000493e4e", "name": "Cancel a render job", "request": { "name": "Cancel a render job", "description": { "content": "Cancels a render job that has not reached a terminal state.", "type": "text/plain" }, "url": { "path": [ "v1", "render", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0d2661bc-71b3-46eb-a3ea-fea00a69c6ed", "name": "Cancellation result", "originalRequest": { "url": { "path": [ "v1", "render", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"jobId\": \"string\",\n \"status\": \"string\",\n \"previousStatus\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7c0b060-8831-45b4-a610-7c796b55b536", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "render", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b4ecdfb-6ef7-4e25-aae3-055bb3c6e48f", "name": "Job already terminal", "originalRequest": { "url": { "path": [ "v1", "render", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a5d564b-5d90-4a49-8b0b-f55c0aba9899", "name": "Download rendered video", "request": { "name": "Download rendered video", "description": { "content": "Redirects to the signed CDN URL for the completed render.", "type": "text/plain" }, "url": { "path": [ "v1", "render", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "74916b98-3de2-4318-823b-a645a644559b", "name": "Redirect to signed download URL", "originalRequest": { "url": { "path": [ "v1", "render", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Found", "code": 302, "header": [ { "disabled": false, "key": "Location", "value": "https://R.jgqsQuyStUh77OBGSfrLQcsiqSR,QqgwEiVR4ckGWAco7FV", "description": "" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "182e1506-488f-4b4f-b6ef-b907d3f4ab43", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "render", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e864ab1e-107e-4701-9871-cde99834525a", "name": "Get rendered video download URL", "request": { "name": "Get rendered video download URL", "description": {}, "url": { "path": [ "v1", "render", ":id", "download-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "3f4eab80-6b75-4e2f-ae52-77439120a035", "name": "Download URL and filename", "originalRequest": { "url": { "path": [ "v1", "render", ":id", "download-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"downloadUrl\": \"http://k.fesfuJ1h7L\",\n \"filename\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e314e1f-0762-4183-9717-010d2adc7bc4", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "render", ":id", "download-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a0941248-b554-4902-aa65-c3f6feaf11e1", "name": "Refresh signed download URL", "request": { "name": "Refresh signed download URL", "description": {}, "url": { "path": [ "v1", "render", ":id", "refresh-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "4833bb38-eba6-4ad8-ba25-ad3d569c7fb5", "name": "Fresh signed URL", "originalRequest": { "url": { "path": [ "v1", "render", ":id", "refresh-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"downloadUrl\": \"https://XKMAdbVv.evpLT,hjMSnRoVGVUR0O9ZOk8WT,nwgA8wCdaqoiDm\",\n \"expiresInSeconds\": 1605\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11503cbb-d1f7-41f5-8f11-875b9a6036c7", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "render", ":id", "refresh-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a7589511-a256-4e0b-8db0-e55d2ca0722b", "name": "Track render download bandwidth", "request": { "name": "Track render download bandwidth", "description": { "content": "Records bandwidth usage for renders streamed directly from the CDN.", "type": "text/plain" }, "url": { "path": [ "v1", "render", ":id", "track-bandwidth" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "9e020485-103b-452f-852a-24ae38258df1", "name": "Bandwidth tracking result", "originalRequest": { "url": { "path": [ "v1", "render", ":id", "track-bandwidth" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tracked\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d1dbaac-7657-4704-8fb6-c0bcf930a78e", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "render", ":id", "track-bandwidth" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9f3b10d5-43d3-4e6e-b1d4-f2f6f266d808", "name": "Templates", "description": { "content": "Pre-built video templates", "type": "text/plain" }, "item": [ { "id": "a0a18899-428b-4ac5-a86f-b8fc89e9592e", "name": "List all templates", "request": { "name": "List all templates", "description": {}, "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ea0caeea-93c8-4cc5-8239-33f18a7abb17", "name": "List of available templates", "originalRequest": { "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"templates\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"platform\": \"general\",\n \"accentColor\": \"string\",\n \"icon\": \"string\",\n \"mode\": \"preset\",\n \"description\": \"string\",\n \"toolId\": \"string\",\n \"variablesSchema\": [\n {\n \"key_0\": 1297.079685517103,\n \"key_1\": 5827,\n \"key_2\": true\n },\n {\n \"key_0\": true,\n \"key_1\": \"string\"\n }\n ]\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"platform\": \"instagram\",\n \"accentColor\": \"string\",\n \"icon\": \"string\",\n \"mode\": \"project\",\n \"description\": \"string\",\n \"toolId\": \"string\",\n \"variablesSchema\": [\n {\n \"key_0\": true\n },\n {\n \"key_0\": 7514,\n \"key_1\": 292\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7bbe06e2-544c-4347-a4bf-2249393d162f", "name": "Get a single template", "request": { "name": "Get a single template", "description": {}, "url": { "path": [ "v1", "templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d09facf5-8bd8-4c67-b72c-46ca489aebf1", "name": "Full template object", "originalRequest": { "url": { "path": [ "v1", "templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"template\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"platform\": \"youtube\",\n \"accentColor\": \"string\",\n \"icon\": \"string\",\n \"mode\": \"project\",\n \"description\": \"string\",\n \"toolId\": \"string\",\n \"variablesSchema\": [\n {\n \"key_0\": 635,\n \"key_1\": 7884\n },\n {\n \"key_0\": 5859.1425352694505,\n \"key_1\": \"string\",\n \"key_2\": true,\n \"key_3\": false\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c8d2ef7-872c-4701-ab84-7dc71131cea4", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4809b6e4-4ffb-4297-bfec-3f00a8e0044d", "name": "Render a template with variables", "request": { "name": "Render a template with variables", "description": {}, "url": { "path": [ "v1", "templates", ":id", "render" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "key": "Idempotency-Key", "value": "", "description": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"variables\": {\n \"key_0\": 7788,\n \"key_1\": 3442.2881682213447\n },\n \"webhookUrl\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e1a65433-ad42-4703-8dc9-dc70bdad6e0f", "name": "Render job queued", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "render" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "key": "Idempotency-Key", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"variables\": {\n \"key_0\": 4054.6273146158264,\n \"key_1\": 7448\n },\n \"webhookUrl\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Present with value `true` when replayed from cache.", "key": "Idempotent-Replay", "value": "true" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"jobId\": \"81197f20-7d1d-dd0a-0091-3f416d590093\",\n \"status\": \"string\",\n \"stage\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7d5f9d5-beb2-4e7a-8fee-df89564af727", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "render" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "key": "Idempotency-Key", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"variables\": {\n \"key_0\": 4054.6273146158264,\n \"key_1\": 7448\n },\n \"webhookUrl\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f454c0c8-158f-47c9-9fec-7e5966995f34", "name": "Insufficient API credits", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "render" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "key": "Idempotency-Key", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"variables\": {\n \"key_0\": 4054.6273146158264,\n \"key_1\": 7448\n },\n \"webhookUrl\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3b240b7-eeae-4d65-b3a6-be358d6a3426", "name": "Template not found", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "render" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "key": "Idempotency-Key", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"variables\": {\n \"key_0\": 4054.6273146158264,\n \"key_1\": 7448\n },\n \"webhookUrl\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "399b7528-cdf2-4847-8e11-928214f53d7d", "name": "Too many active render jobs", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "render" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "key": "Idempotency-Key", "value": "", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"variables\": {\n \"key_0\": 4054.6273146158264,\n \"key_1\": 7448\n },\n \"webhookUrl\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "121abb5a-e942-425e-bc19-4b1ae4548077", "name": "Tools", "description": { "content": "Cloud video editing tools (native ffmpeg or full render pipeline)", "type": "text/plain" }, "item": [ { "id": "bcac61de-1d36-4c33-9024-a836506fd9db", "name": "Queue a cloud tool job", "request": { "name": "Queue a cloud tool job", "description": { "content": "Submit a public or presigned input URL and tool-specific configuration. Simple tools run on a native ffmpeg worker; studio tools fall back to the full render pipeline.", "type": "text/plain" }, "url": { "path": [ "v1", "tools", ":toolId", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "toolId", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"inputUrl\": \"\",\n \"config\": {\n \"key_0\": 8949.916803341008,\n \"key_1\": false\n },\n \"webhookUrl\": \"\",\n \"duration\": \"\",\n \"dimensions\": {\n \"width\": \"\",\n \"height\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "eae4ec40-f95d-49b8-a765-d88c8cf5acea", "name": "Tool job queued", "originalRequest": { "url": { "path": [ "v1", "tools", ":toolId", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "toolId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inputUrl\": \"\",\n \"config\": {\n \"key_0\": 8159.344361789742\n },\n \"webhookUrl\": \"\",\n \"duration\": \"\",\n \"dimensions\": {\n \"width\": \"\",\n \"height\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"jobId\": \"9f56ec7d-cfe4-2353-ef96-cad7bd1c29be\",\n \"status\": \"processing\",\n \"stage\": \"processing\",\n \"mode\": \"render\",\n \"outputKey\": \"string\",\n \"url\": \"http://GAoNXnNxURTQeEvbXrBTO.tznin1.1ajb,r89G8i6WaNC6w2lydi3BGvtL0UmmKjCuMj4qk4i0jiGAPJ\",\n \"error\": \"string\",\n \"progress\": {\n \"done\": 6614,\n \"total\": 315,\n \"percent\": 74\n },\n \"outputs\": [\n {\n \"id\": \"15059d41-b894-7ba9-c630-efd3b90d2461\",\n \"integration_id\": \"25db4185-6739-5e9b-9871-82c0a1659027\",\n \"provider\": \"string\",\n \"output_key\": \"string\",\n \"output_url\": \"http://EYVkUCkYjrSswMAZUO.vrH-TVMF+ezsHw0psvutFf0,6F\",\n \"output_size_bytes\": 5624,\n \"status\": \"string\",\n \"error\": \"string\",\n \"created_at\": \"1949-01-18T16:29:31.528Z\",\n \"updated_at\": \"1953-01-16T03:59:29.955Z\"\n },\n {\n \"id\": \"56497d9d-5030-b21d-48ac-45bcbe5699e2\",\n \"integration_id\": \"da6bffa4-52b4-0a08-39da-bb2c69f9fb1a\",\n \"provider\": \"string\",\n \"output_key\": \"string\",\n \"output_url\": \"http://IsxMVeGVnoJoitDYLoFHAUPhQMCawI.hngdD6J37xS7wj+y02tg9XBvPI\",\n \"output_size_bytes\": 1547,\n \"status\": \"string\",\n \"error\": \"string\",\n \"created_at\": \"1965-08-22T22:41:04.964Z\",\n \"updated_at\": \"1948-07-29T22:21:10.615Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dc92b40-10a8-4471-8717-77a64a41fcdd", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "tools", ":toolId", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "toolId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inputUrl\": \"\",\n \"config\": {\n \"key_0\": 8159.344361789742\n },\n \"webhookUrl\": \"\",\n \"duration\": \"\",\n \"dimensions\": {\n \"width\": \"\",\n \"height\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a04423d9-a2a8-4d97-952b-dd66a5a56438", "name": "Insufficient API credits", "originalRequest": { "url": { "path": [ "v1", "tools", ":toolId", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "toolId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inputUrl\": \"\",\n \"config\": {\n \"key_0\": 8159.344361789742\n },\n \"webhookUrl\": \"\",\n \"duration\": \"\",\n \"dimensions\": {\n \"width\": \"\",\n \"height\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bc32621-ed58-49a8-adde-e78590494d1b", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "tools", ":toolId", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "toolId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inputUrl\": \"\",\n \"config\": {\n \"key_0\": 8159.344361789742\n },\n \"webhookUrl\": \"\",\n \"duration\": \"\",\n \"dimensions\": {\n \"width\": \"\",\n \"height\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fde214ee-c645-438a-a6a2-c23be0c48ae3", "name": "Too many active jobs", "originalRequest": { "url": { "path": [ "v1", "tools", ":toolId", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "toolId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inputUrl\": \"\",\n \"config\": {\n \"key_0\": 8159.344361789742\n },\n \"webhookUrl\": \"\",\n \"duration\": \"\",\n \"dimensions\": {\n \"width\": \"\",\n \"height\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a2b6ef9-d3f3-43cf-b2a1-2c18c72b20bf", "name": "Get tool job status", "request": { "name": "Get tool job status", "description": {}, "url": { "path": [ "v1", "tools", "jobs", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "3553ce04-bb03-4ebd-8ccf-c7c2a3123599", "name": "Current tool job status", "originalRequest": { "url": { "path": [ "v1", "tools", "jobs", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"jobId\": \"112b5304-bbd6-57f2-eb06-9a3b97f535f9\",\n \"status\": \"processing\",\n \"stage\": \"processing\",\n \"mode\": \"render\",\n \"outputKey\": \"string\",\n \"url\": \"https://ArrCQiAoQNUIfoCHVABEd.rioE1.PonIEVjyZ16414CjnDm\",\n \"error\": \"string\",\n \"progress\": {\n \"done\": 6185,\n \"total\": 6375,\n \"percent\": 4290\n },\n \"outputs\": [\n {\n \"id\": \"ee3ce1c1-a95d-d8f4-4083-89aceccf6b09\",\n \"integration_id\": \"638518c6-c02a-827d-7f48-dc8934604097\",\n \"provider\": \"string\",\n \"output_key\": \"string\",\n \"output_url\": \"https://ThcIVfFcriwptOeCCdlTENlfmFACv.yiIFwfRYpJHcw5lze.\",\n \"output_size_bytes\": 1880,\n \"status\": \"string\",\n \"error\": \"string\",\n \"created_at\": \"2010-05-10T16:22:12.732Z\",\n \"updated_at\": \"1994-08-09T07:32:22.440Z\"\n },\n {\n \"id\": \"ab0ab8d4-0512-6fcc-7875-151f88f2e554\",\n \"integration_id\": \"95024d5a-ed36-8543-2c05-41e1285737a3\",\n \"provider\": \"string\",\n \"output_key\": \"string\",\n \"output_url\": \"http://pRCVODUAsmOAijTBCapPNiwbehw.poguClCwvPTdkldUZMX4Yh\",\n \"output_size_bytes\": 6726,\n \"status\": \"string\",\n \"error\": \"string\",\n \"created_at\": \"1962-05-10T07:06:36.136Z\",\n \"updated_at\": \"1965-08-25T09:57:35.655Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "705a63ea-6063-4f65-afd3-0b133fb93f36", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "tools", "jobs", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ebed763-385c-489b-9d92-3497a9cbedcc", "name": "Download a completed tool job result", "request": { "name": "Download a completed tool job result", "description": { "content": "Redirects to the CDN or signed URL for the completed output file.", "type": "text/plain" }, "url": { "path": [ "v1", "tools", "jobs", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e8545969-28e1-4e7d-b0df-68b546cc9f08", "name": "Redirect to output file", "originalRequest": { "url": { "path": [ "v1", "tools", "jobs", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Found", "code": 302, "header": [ { "disabled": false, "key": "Location", "value": "https://R.jgqsQuyStUh77OBGSfrLQcsiqSR,QqgwEiVR4ckGWAco7FV", "description": "" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "03f037de-bfd7-41d2-8828-004e55089e58", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "tools", "jobs", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9921130b-ded6-4481-b898-13c460619693", "name": "Projects", "description": { "content": "User-scoped video projects", "type": "text/plain" }, "item": [ { "id": "7c2ca9a8-993d-4741-9c09-4777653cec3a", "name": "List user projects", "request": { "name": "List user projects", "description": {}, "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "sortBy", "value": "updated_at" }, { "disabled": false, "key": "sortOrder", "value": "desc" }, { "disabled": false, "key": "search", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1d6a8573-cfea-4820-96b7-7395579c1ee0", "name": "User's projects", "originalRequest": { "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "25" }, { "key": "sortBy", "value": "updated_at" }, { "key": "sortOrder", "value": "desc" }, { "key": "search", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"projects\": [\n {\n \"id\": \"da97f255-5c21-1d39-cd89-b2de85073d07\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"video_json\": {},\n \"thumbnail_url\": \"http://KwejngViwouf.qzoL7Z2nR3Bm\",\n \"sprite_url\": \"https://pAdgCyRNbaIf.avbRwtlGqV+lnVjv,Tj7jNSAUs5UO3u4t5KlkB\",\n \"duration\": 3998,\n \"width\": 2461,\n \"height\": 2404,\n \"status\": \"string\",\n \"render_job_id\": \"string\",\n \"output_url\": \"https://BvkGV.rxlogSgn+Vnk4\",\n \"processed_at\": \"1969-12-28T08:24:12.805Z\",\n \"created_at\": \"1948-12-02T08:40:43.989Z\",\n \"updated_at\": \"1969-01-22T14:38:16.234Z\",\n \"last_opened_at\": \"1950-03-28T03:32:31.589Z\"\n },\n {\n \"id\": \"fe82d688-246e-61d2-cf53-adccbf4e6936\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"video_json\": {},\n \"thumbnail_url\": \"https://FRahdMEEQYSWdaTzXlivUh.ccscZ59kdwdjn9SaQ0.5ZNspYgUbw.kKzjA.UCd\",\n \"sprite_url\": \"http://DIDbueqL.tcvYL.Brgx2eSQF8rkz9kSTUxLsLlZ0hTtXNbBIBp\",\n \"duration\": 3585,\n \"width\": 6582,\n \"height\": 6937,\n \"status\": \"string\",\n \"render_job_id\": \"string\",\n \"output_url\": \"https://mYLHPATCGHCoZNCsKPUTYoaxOycUoI.jahpdxuHzQDoUPIPZtt,R\",\n \"processed_at\": \"1964-06-03T23:21:51.413Z\",\n \"created_at\": \"1983-12-09T12:40:49.959Z\",\n \"updated_at\": \"1993-03-15T20:57:05.003Z\",\n \"last_opened_at\": \"1953-05-07T16:01:09.502Z\"\n }\n ],\n \"total\": 1724,\n \"page\": 3528,\n \"limit\": 2478,\n \"totalPages\": 6446\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efce0a15-92ed-46eb-a3a8-8eb9d6bc88b5", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "25" }, { "key": "sortBy", "value": "updated_at" }, { "key": "sortOrder", "value": "desc" }, { "key": "search", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "699a388c-9c4d-4e65-8b45-19d192364284", "name": "Create a project", "request": { "name": "Create a project", "description": {}, "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"video_json\": \"\",\n \"thumbnail_url\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5d164eaf-5060-49ae-8449-600ba8e3b65e", "name": "Project created", "originalRequest": { "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"video_json\": \"\",\n \"thumbnail_url\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"project\": {\n \"id\": \"b5566ccc-db9d-ed7d-02ec-e3d0c6af6d60\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"video_json\": {},\n \"thumbnail_url\": \"http://GEPEyqoXDsAltJEHsEYBZNu.uokWwadPvgGGcojeoboYwORpD7ut\",\n \"sprite_url\": \"https://aCySXSSETSmhyOqOkSaQVQO.krdZxByZd,Yvw3cO1Al26V9ucJul2yx0,k6WoBVR1G7dn-Qf\",\n \"duration\": 5600,\n \"width\": 6559,\n \"height\": 5329,\n \"status\": \"string\",\n \"render_job_id\": \"string\",\n \"output_url\": \"https://XtppuOnmkDKaRb.ribKbWqdXMcPIVOEKFaXDUhLN.mS\",\n \"processed_at\": \"2023-10-12T12:04:06.695Z\",\n \"created_at\": \"2022-09-03T15:40:52.759Z\",\n \"updated_at\": \"1977-02-02T00:41:22.259Z\",\n \"last_opened_at\": \"1950-04-01T18:33:55.132Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcd96a7f-a725-4733-9bad-2317999f164e", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"video_json\": \"\",\n \"thumbnail_url\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f012dc82-5183-4aba-bfd2-ad476c3bb7a1", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"video_json\": \"\",\n \"thumbnail_url\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7950acb9-81e5-4652-9dcb-5ec49298136f", "name": "Get total project count", "request": { "name": "Get total project count", "description": {}, "url": { "path": [ "v1", "projects", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b1d215bc-2650-4bac-8304-50b5a2a43340", "name": "Project count", "originalRequest": { "url": { "path": [ "v1", "projects", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 9704\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dcc3383-664b-4ad1-98f2-a43adb13fea9", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "projects", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f6681d0-4125-477e-9603-0569495eec67", "name": "Get a project", "request": { "name": "Get a project", "description": {}, "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "94901912-0bc0-4493-b78e-889c678187cc", "name": "Project details", "originalRequest": { "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"project\": {\n \"id\": \"8ef7a303-4661-f79e-eaab-40744534892e\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"video_json\": {},\n \"thumbnail_url\": \"https://tFALVPxg.cknkWFPCTL4yzKZG54G\",\n \"sprite_url\": \"http://qyiiBSqYcWCetxJPQJXexBAgcyhG.gmgs4d7cBL++EGxwe+56+lvZXNA1ZY90AxTh.tRfcc0Gn4AKCt5cploFD-f,\",\n \"duration\": 3197,\n \"width\": 3189,\n \"height\": 5331,\n \"status\": \"string\",\n \"render_job_id\": \"string\",\n \"output_url\": \"https://cSiIqzCfQAonfXL.oedeuoAqdUmi,8nxrH,JJM,f.YP2fucd\",\n \"processed_at\": \"1982-05-18T04:54:55.011Z\",\n \"created_at\": \"1979-10-19T04:48:19.278Z\",\n \"updated_at\": \"1973-07-03T06:12:27.808Z\",\n \"last_opened_at\": \"1975-03-24T18:13:05.806Z\"\n },\n \"lastRendition\": {\n \"id\": \"33dd55a4-db9a-af17-d349-f2798074ba66\",\n \"job_id\": \"string\",\n \"project_id\": \"b6fa0f7f-edfa-313d-6213-23b26827f1ea\",\n \"status\": \"string\",\n \"stage\": \"string\",\n \"cost\": 3405.706039276094,\n \"duration\": 3353.7567339239495,\n \"width\": 3068,\n \"height\": 1725,\n \"fps\": 2827,\n \"output_url\": \"http://sUdx.kmpKqqaDS1uZYdDeoe0N27e.\",\n \"output_size_bytes\": 9757,\n \"error\": \"string\",\n \"progress_percent\": 2054,\n \"sprite_url\": \"http://MMzbYkWAXiLk.szTHVSbWjkNMiGhYb2-Tpq1B7j9E41483YejxMgiwiyGGdN\",\n \"video_json\": {},\n \"outputs\": [\n {\n \"id\": \"e6248be8-f275-0ff5-aea3-4ea4c054f4d6\",\n \"integration_id\": \"f44e94f8-ac45-1ec6-6303-930b3d637240\",\n \"provider\": \"string\",\n \"output_key\": \"string\",\n \"output_url\": \"http://LMVlBmTMcHDKyTgTslzKChpMFFmnjRph.vfkrtJBlDU7fiV\",\n \"output_size_bytes\": 7843,\n \"status\": \"string\",\n \"error\": \"string\",\n \"created_at\": \"2018-01-16T10:35:49.333Z\",\n \"updated_at\": \"2019-08-27T05:43:25.891Z\"\n },\n {\n \"id\": \"1bab77bd-03e5-c6c7-86fc-d2d6a17232c0\",\n \"integration_id\": \"3188bffb-7ed5-84e0-36a7-2fd0e9c1890a\",\n \"provider\": \"string\",\n \"output_key\": \"string\",\n \"output_url\": \"https://eQZL.vrloLTMLc2Gz,bqCHlQWvAWaHsryCqzqsjQmCXl5mXx88tK\",\n \"output_size_bytes\": 9138,\n \"status\": \"string\",\n \"error\": \"string\",\n \"created_at\": \"2016-12-26T23:35:13.487Z\",\n \"updated_at\": \"2019-07-09T03:26:59.220Z\"\n }\n ],\n \"projects\": {},\n \"created_at\": \"2010-01-21T15:57:53.317Z\",\n \"completed_at\": \"2001-05-05T19:19:17.697Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a03ef910-6f83-4c97-85d9-6aaea8934590", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e4b7d92-68fc-4f7c-b460-9f499861d20d", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa693de0-bbc5-40cd-bc80-e87938ad3806", "name": "Update a project", "request": { "name": "Update a project", "description": {}, "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"video_json\": \"\",\n \"thumbnail_url\": \"\",\n \"thumbnail_base64\": \"\",\n \"sprite_url\": \"\",\n \"sprite_base64\": \"\",\n \"last_opened_at\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "041fbf9d-4e29-4fea-9040-87e8c9087fe8", "name": "Updated project", "originalRequest": { "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"video_json\": \"\",\n \"thumbnail_url\": \"\",\n \"thumbnail_base64\": \"\",\n \"sprite_url\": \"\",\n \"sprite_base64\": \"\",\n \"last_opened_at\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"project\": {\n \"id\": \"b5566ccc-db9d-ed7d-02ec-e3d0c6af6d60\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"video_json\": {},\n \"thumbnail_url\": \"http://GEPEyqoXDsAltJEHsEYBZNu.uokWwadPvgGGcojeoboYwORpD7ut\",\n \"sprite_url\": \"https://aCySXSSETSmhyOqOkSaQVQO.krdZxByZd,Yvw3cO1Al26V9ucJul2yx0,k6WoBVR1G7dn-Qf\",\n \"duration\": 5600,\n \"width\": 6559,\n \"height\": 5329,\n \"status\": \"string\",\n \"render_job_id\": \"string\",\n \"output_url\": \"https://XtppuOnmkDKaRb.ribKbWqdXMcPIVOEKFaXDUhLN.mS\",\n \"processed_at\": \"2023-10-12T12:04:06.695Z\",\n \"created_at\": \"2022-09-03T15:40:52.759Z\",\n \"updated_at\": \"1977-02-02T00:41:22.259Z\",\n \"last_opened_at\": \"1950-04-01T18:33:55.132Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9873b555-194f-4a61-84f7-2e3407a44d05", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"video_json\": \"\",\n \"thumbnail_url\": \"\",\n \"thumbnail_base64\": \"\",\n \"sprite_url\": \"\",\n \"sprite_base64\": \"\",\n \"last_opened_at\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53fd50fa-a5cb-465f-8b45-02ea2f49b773", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"video_json\": \"\",\n \"thumbnail_url\": \"\",\n \"thumbnail_base64\": \"\",\n \"sprite_url\": \"\",\n \"sprite_base64\": \"\",\n \"last_opened_at\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b92d9045-865c-4ace-9440-dfbf03de167b", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"video_json\": \"\",\n \"thumbnail_url\": \"\",\n \"thumbnail_base64\": \"\",\n \"sprite_url\": \"\",\n \"sprite_base64\": \"\",\n \"last_opened_at\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "358933c6-29ca-489b-aba3-74e2d12dfc50", "name": "Partially update a project", "request": { "name": "Partially update a project", "description": {}, "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"video_json\": \"\",\n \"thumbnail_url\": \"\",\n \"thumbnail_base64\": \"\",\n \"sprite_url\": \"\",\n \"sprite_base64\": \"\",\n \"last_opened_at\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "08830373-5cdd-417a-9ae1-2c46b8cbd46f", "name": "Updated project", "originalRequest": { "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"video_json\": \"\",\n \"thumbnail_url\": \"\",\n \"thumbnail_base64\": \"\",\n \"sprite_url\": \"\",\n \"sprite_base64\": \"\",\n \"last_opened_at\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"project\": {\n \"id\": \"b5566ccc-db9d-ed7d-02ec-e3d0c6af6d60\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"video_json\": {},\n \"thumbnail_url\": \"http://GEPEyqoXDsAltJEHsEYBZNu.uokWwadPvgGGcojeoboYwORpD7ut\",\n \"sprite_url\": \"https://aCySXSSETSmhyOqOkSaQVQO.krdZxByZd,Yvw3cO1Al26V9ucJul2yx0,k6WoBVR1G7dn-Qf\",\n \"duration\": 5600,\n \"width\": 6559,\n \"height\": 5329,\n \"status\": \"string\",\n \"render_job_id\": \"string\",\n \"output_url\": \"https://XtppuOnmkDKaRb.ribKbWqdXMcPIVOEKFaXDUhLN.mS\",\n \"processed_at\": \"2023-10-12T12:04:06.695Z\",\n \"created_at\": \"2022-09-03T15:40:52.759Z\",\n \"updated_at\": \"1977-02-02T00:41:22.259Z\",\n \"last_opened_at\": \"1950-04-01T18:33:55.132Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48671b30-13cc-44e3-baee-66bfd92d5c35", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"video_json\": \"\",\n \"thumbnail_url\": \"\",\n \"thumbnail_base64\": \"\",\n \"sprite_url\": \"\",\n \"sprite_base64\": \"\",\n \"last_opened_at\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98793dac-3937-49db-8428-2388a2881f87", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"video_json\": \"\",\n \"thumbnail_url\": \"\",\n \"thumbnail_base64\": \"\",\n \"sprite_url\": \"\",\n \"sprite_base64\": \"\",\n \"last_opened_at\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d08862ac-6149-4ce5-a8cc-595d83496063", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"video_json\": \"\",\n \"thumbnail_url\": \"\",\n \"thumbnail_base64\": \"\",\n \"sprite_url\": \"\",\n \"sprite_base64\": \"\",\n \"last_opened_at\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a572fad5-aba5-4294-bc9a-44982e6038be", "name": "Delete a project", "request": { "name": "Delete a project", "description": {}, "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a1ca8377-b488-4a8e-ba97-3c0410cbe8de", "name": "Deleted successfully", "originalRequest": { "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"deleted\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66c1e74c-5f55-49f0-a83d-e1180300a503", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acdafa96-7e21-43fa-bcf2-ed63705adbb7", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "14798923-f8fc-4ee0-8b54-7cc6bd59f0b5", "name": "Duplicate a project", "request": { "name": "Duplicate a project", "description": {}, "url": { "path": [ "v1", "projects", ":id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "acba74da-6ff4-4bd9-89b2-2d48a35d8471", "name": "Duplicated project", "originalRequest": { "url": { "path": [ "v1", "projects", ":id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"project\": {\n \"id\": \"b5566ccc-db9d-ed7d-02ec-e3d0c6af6d60\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"video_json\": {},\n \"thumbnail_url\": \"http://GEPEyqoXDsAltJEHsEYBZNu.uokWwadPvgGGcojeoboYwORpD7ut\",\n \"sprite_url\": \"https://aCySXSSETSmhyOqOkSaQVQO.krdZxByZd,Yvw3cO1Al26V9ucJul2yx0,k6WoBVR1G7dn-Qf\",\n \"duration\": 5600,\n \"width\": 6559,\n \"height\": 5329,\n \"status\": \"string\",\n \"render_job_id\": \"string\",\n \"output_url\": \"https://XtppuOnmkDKaRb.ribKbWqdXMcPIVOEKFaXDUhLN.mS\",\n \"processed_at\": \"2023-10-12T12:04:06.695Z\",\n \"created_at\": \"2022-09-03T15:40:52.759Z\",\n \"updated_at\": \"1977-02-02T00:41:22.259Z\",\n \"last_opened_at\": \"1950-04-01T18:33:55.132Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00be84c0-d415-4b6a-bfa8-c7b3984d16c3", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "projects", ":id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfe27830-76f2-49fd-9152-a4aca64ac1fa", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "64f132f1-3c34-4755-b492-3d16734045f0", "name": "Bulk delete projects", "request": { "name": "Bulk delete projects", "description": {}, "url": { "path": [ "v1", "projects", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "286054f4-4888-41a8-86a6-9f41d7de1307", "name": "Deleted projects", "originalRequest": { "url": { "path": [ "v1", "projects", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 7673,\n \"deleted\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "826c5113-1b88-4899-89e6-ae55002cdda5", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "projects", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b8d7748-b68c-4653-ad84-777e8bb4eab6", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "projects", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "cc7181eb-03b5-4489-86c3-ebeafbe08cd6", "name": "Assets", "description": { "content": "Workspace asset uploads and signed URLs (Bunny Storage)", "type": "text/plain" }, "item": [ { "id": "ff5a50ed-6970-4547-a8f9-542c907ce00b", "name": "List workspace assets", "request": { "name": "List workspace assets", "description": {}, "url": { "path": [ "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "type", "value": "" }, { "disabled": false, "key": "search", "value": "" }, { "disabled": false, "key": "sortBy", "value": "created_at" }, { "disabled": false, "key": "sortOrder", "value": "desc" }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b12a87c6-b965-41c1-994a-3b80908b083b", "name": "Paginated list of assets", "originalRequest": { "url": { "path": [ "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" }, { "key": "search", "value": "" }, { "key": "sortBy", "value": "created_at" }, { "key": "sortOrder", "value": "desc" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"assets\": [\n {\n \"id\": \"c56ae706-5611-96d9-4591-f5e9816045d2\",\n \"workspace_id\": \"474777e5-ff2c-e8f2-08cd-13e7c77737f0\",\n \"name\": \"string\",\n \"type\": \"font\",\n \"storage_key\": \"string\",\n \"size_bytes\": 3834,\n \"created_at\": \"1992-07-11T18:39:18.461Z\",\n \"asset_url\": \"http://moorEgGLYfBOUitqV.bknyv1SsngHxTMvqXTgO,PI8wL,.yXVisYtc\",\n \"duration\": 3551,\n \"width\": 28,\n \"height\": 100,\n \"created_by\": \"884aa6fa-cab7-f3d9-aca6-c6a1e077b0d4\",\n \"updated_at\": \"1963-12-06T09:33:29.628Z\"\n },\n {\n \"id\": \"e03a30ba-bec0-58d8-5caa-32e7da9a4700\",\n \"workspace_id\": \"447a6859-451b-0280-44b8-1451134aa3ce\",\n \"name\": \"string\",\n \"type\": \"audio\",\n \"storage_key\": \"string\",\n \"size_bytes\": 6173,\n \"created_at\": \"2000-07-25T02:19:47.474Z\",\n \"asset_url\": \"http://mDNATQRKjhJnEKO.mjnNdKSpqdH5+dRM-9.Ah8zIXRplu9XEILL\",\n \"duration\": 5780,\n \"width\": 4433,\n \"height\": 8646,\n \"created_by\": \"0341342d-fc1e-0fb2-cf6f-f51b95dcb935\",\n \"updated_at\": \"2007-12-12T12:30:44.076Z\"\n }\n ],\n \"total\": 7662,\n \"page\": 6023,\n \"limit\": 3286,\n \"totalPages\": 8249\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c18ffe17-9d81-480a-bc2f-d919bb19ae03", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" }, { "key": "search", "value": "" }, { "key": "sortBy", "value": "created_at" }, { "key": "sortOrder", "value": "desc" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0a044f73-e015-45c4-9993-93d64d918bcd", "name": "Register an uploaded asset", "request": { "name": "Register an uploaded asset", "description": { "content": "Register an asset after it has been uploaded to Bunny Storage. Use `POST /v1/assets/upload-url` first.", "type": "text/plain" }, "url": { "path": [ "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"storage_key\": \"\",\n \"size_bytes\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "571a1e7d-9db3-43a3-baf3-2d2d21160f42", "name": "Asset registered", "originalRequest": { "url": { "path": [ "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"storage_key\": \"\",\n \"size_bytes\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"asset\": {\n \"id\": \"574f6695-2079-2028-33e4-65c8f463f0cd\",\n \"workspace_id\": \"564867eb-3357-9155-ae1d-820a237df23e\",\n \"name\": \"string\",\n \"type\": \"font\",\n \"storage_key\": \"string\",\n \"size_bytes\": 4662,\n \"created_at\": \"1967-06-09T22:33:44.116Z\",\n \"asset_url\": \"https://PRNWnPCcSuMCvCXm.vedv\",\n \"duration\": 9952,\n \"width\": 3692,\n \"height\": 2852,\n \"created_by\": \"496b6619-60db-f43d-9b9a-90a5f59fadbb\",\n \"updated_at\": \"2022-10-22T00:20:02.062Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9145d5ef-a47d-4b20-98f6-15cfac2344bd", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"storage_key\": \"\",\n \"size_bytes\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "181b5e49-c3d8-4f8e-a076-57dfaadd552b", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"storage_key\": \"\",\n \"size_bytes\": \"\",\n \"duration\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "35cc82f0-ef90-43cb-a5e0-9a690dcd0792", "name": "Get asset upload URL", "request": { "name": "Get asset upload URL", "description": { "content": "Returns the upload endpoint and Bunny Storage path for a new asset.", "type": "text/plain" }, "url": { "path": [ "v1", "assets", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"filename\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "78777133-75a9-493c-a624-881743b26847", "name": "Upload URL", "originalRequest": { "url": { "path": [ "v1", "assets", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filename\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"uploadUrl\": \"https://gimkulPYvlJxJphoaUOcrfDAx.lmxvWQtl3ia3mCqrHwsUsPSju+WcE\",\n \"assetUrl\": \"https://o.fjkuO+mIf0K891pQm1vvZpM3HoLC2xBvayCGoyjDCnk\",\n \"path\": \"string\",\n \"assetId\": \"79169385-5014-00cc-6945-6af534d9d865\",\n \"type\": \"video\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6bc2311-d61f-47ae-9d6f-c076312d85ae", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "assets", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filename\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a643fe08-bf90-45be-8ce4-d18cfbb607f1", "name": "Bunny Storage not configured", "originalRequest": { "url": { "path": [ "v1", "assets", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filename\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c73577f-0aef-40f2-8992-0dc1c5827457", "name": "Upload an asset file", "request": { "name": "Upload an asset file", "description": { "content": "Receives a multipart/form-data file upload and forwards it to Bunny Storage.", "type": "text/plain" }, "url": { "path": [ "v1", "assets", ":assetId", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "assetId", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) Asset file (up to 2 GB)." } ] } }, "response": [ { "id": "3c8b81b0-a315-4f7b-aea8-ca56e6b94ee9", "name": "Upload succeeded", "originalRequest": { "url": { "path": [ "v1", "assets", ":assetId", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "assetId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Asset file (up to 2 GB).", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31385092-79dc-45e2-991c-339f35216c68", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "assets", ":assetId", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "assetId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Asset file (up to 2 GB).", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dab66e8f-e914-4db5-961b-aa3c8c60e54b", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "assets", ":assetId", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "assetId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Asset file (up to 2 GB).", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9841c500-3286-4d37-a69e-7e599a79f798", "name": "Bunny Storage not configured", "originalRequest": { "url": { "path": [ "v1", "assets", ":assetId", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "assetId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Asset file (up to 2 GB).", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d438083-7709-4f1a-a44c-939e8a89fc7f", "name": "Get a single asset", "request": { "name": "Get a single asset", "description": {}, "url": { "path": [ "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ffcea019-c928-494f-9dea-643b47a23359", "name": "Asset details", "originalRequest": { "url": { "path": [ "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"asset\": {\n \"id\": \"574f6695-2079-2028-33e4-65c8f463f0cd\",\n \"workspace_id\": \"564867eb-3357-9155-ae1d-820a237df23e\",\n \"name\": \"string\",\n \"type\": \"font\",\n \"storage_key\": \"string\",\n \"size_bytes\": 4662,\n \"created_at\": \"1967-06-09T22:33:44.116Z\",\n \"asset_url\": \"https://PRNWnPCcSuMCvCXm.vedv\",\n \"duration\": 9952,\n \"width\": 3692,\n \"height\": 2852,\n \"created_by\": \"496b6619-60db-f43d-9b9a-90a5f59fadbb\",\n \"updated_at\": \"2022-10-22T00:20:02.062Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9bcba65-da84-4b89-b7c5-ffb798e80aef", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2617b58b-5260-44da-896d-0797b7edb0dd", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e732ee8-9c96-4d46-b960-af23a1008ad6", "name": "Delete an asset", "request": { "name": "Delete an asset", "description": {}, "url": { "path": [ "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1a5c8959-5c49-4901-ab49-6d679f51055d", "name": "Deleted successfully", "originalRequest": { "url": { "path": [ "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"deleted\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b31c954f-93a9-4304-b802-1a6c0beb7868", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31651764-542c-4e0a-8d81-dad40e9e234b", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f957661-1c7d-4bf7-b9ac-80caf5ce0fc2", "name": "Get a public asset URL", "request": { "name": "Get a public asset URL", "description": { "content": "Returns the public Bunny CDN URL for the asset.", "type": "text/plain" }, "url": { "path": [ "v1", "assets", ":id", "signed-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8d6cc492-a809-4cfe-81bb-8e31c542d40b", "name": "Signed URL", "originalRequest": { "url": { "path": [ "v1", "assets", ":id", "signed-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"signedUrl\": \"https://ibRZqdDeyylVqoBRxhdUwTSPKGOZH.rzcmbDTcD-wl9qMi.tyitmKu-\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3393b66-f25b-4038-9998-9126f77b6abc", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "assets", ":id", "signed-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ced361c-6448-4432-a52b-ad55bf2428df", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "assets", ":id", "signed-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7bf15982-7883-463c-8b32-e470dc05eb22", "name": "Proxy an asset through the API", "request": { "name": "Proxy an asset through the API", "description": { "content": "Streams the asset through the API so the browser can fetch it without relying on CDN CORS.", "type": "text/plain" }, "url": { "path": [ "v1", "assets", ":id", "proxy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2c7d79f2-875c-4c5a-b482-9d5f3304282b", "name": "Asset stream", "originalRequest": { "url": { "path": [ "v1", "assets", ":id", "proxy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "81469ce6-c00c-4cc3-8f83-0a602d5e83a4", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "assets", ":id", "proxy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff8d6de2-2d42-4419-974c-1f95ee99a180", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "assets", ":id", "proxy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d493d9d0-2af6-4582-8535-d8b30efe9060", "name": "Bulk delete assets", "request": { "name": "Bulk delete assets", "description": {}, "url": { "path": [ "v1", "assets", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7cee2cd6-e5cd-42d2-b9ab-61ff9ed04c81", "name": "Deleted assets", "originalRequest": { "url": { "path": [ "v1", "assets", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 7673,\n \"deleted\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9009df50-604b-4534-8380-708a19ff29be", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "assets", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7b06602-a6ef-40ea-85e2-7570c58c5234", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "assets", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0c46fd1c-c2b6-47e9-979b-4b4ec67293ab", "name": "Renditions", "description": { "content": "Render history and statistics", "type": "text/plain" }, "item": [ { "id": "000239c1-3500-46ee-97c7-ea911215dace", "name": "List render history", "request": { "name": "List render history", "description": {}, "url": { "path": [ "v1", "renditions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "sortBy", "value": "created_at" }, { "disabled": false, "key": "sortOrder", "value": "desc" }, { "disabled": false, "key": "status", "value": "" }, { "disabled": false, "key": "search", "value": "" }, { "disabled": false, "key": "from", "value": "" }, { "disabled": false, "key": "to", "value": "" }, { "disabled": false, "key": "projectId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5dd54c10-a399-47b7-940b-9fdf6687b383", "name": "Paginated render history", "originalRequest": { "url": { "path": [ "v1", "renditions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "25" }, { "key": "sortBy", "value": "created_at" }, { "key": "sortOrder", "value": "desc" }, { "key": "status", "value": "" }, { "key": "search", "value": "" }, { "key": "from", "value": "" }, { "key": "to", "value": "" }, { "key": "projectId", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"renditions\": [\n {\n \"id\": \"4de120a6-c988-ef43-a8ea-aac76c2b186e\",\n \"job_id\": \"string\",\n \"project_id\": \"b6c4f084-608a-6584-4194-562cec4a39ee\",\n \"status\": \"string\",\n \"stage\": \"string\",\n \"cost\": 2375.2589957125438,\n \"duration\": 8787.185288856712,\n \"width\": 1807,\n \"height\": 8515,\n \"fps\": 7944,\n \"output_url\": \"http://iGvqnxld.mtih.n.dsDNM2BsRzZj\",\n \"output_size_bytes\": 6921,\n \"error\": \"string\",\n \"progress_percent\": 5112,\n \"sprite_url\": \"http://wtwccd.agdZhn0MlAskjh.awfSZG0ympgZsTaMzGpH5hlVmBVi8-EyNeRphs,\",\n \"video_json\": {},\n \"outputs\": [\n {\n \"id\": \"e45aa32a-1ccb-64a6-a083-2560255b2c9c\",\n \"integration_id\": \"58571010-1c84-d630-8faa-40600b661125\",\n \"provider\": \"string\",\n \"output_key\": \"string\",\n \"output_url\": \"http://dBoenwSttO.mfoEeKVj2GPc1Mk5sb2SumUFYl9h6YTWAMa\",\n \"output_size_bytes\": 3534,\n \"status\": \"string\",\n \"error\": \"string\",\n \"created_at\": \"1968-06-21T01:45:22.265Z\",\n \"updated_at\": \"1971-02-08T07:57:01.174Z\"\n },\n {\n \"id\": \"4456b70d-1520-4af1-4b7a-05b8e8ff2ccb\",\n \"integration_id\": \"b15cce74-78f0-d792-60bc-aa5ce42e105a\",\n \"provider\": \"string\",\n \"output_key\": \"string\",\n \"output_url\": \"http://WlOfrvIElZn.fiCITGqnZen\",\n \"output_size_bytes\": 581,\n \"status\": \"string\",\n \"error\": \"string\",\n \"created_at\": \"2013-03-16T03:35:21.824Z\",\n \"updated_at\": \"1973-03-13T22:19:22.792Z\"\n }\n ],\n \"projects\": {},\n \"created_at\": \"2019-10-26T15:57:39.983Z\",\n \"completed_at\": \"1968-08-28T04:48:26.608Z\"\n },\n {\n \"id\": \"77dfef16-0ac6-e9e0-9fa6-0cf080ef971e\",\n \"job_id\": \"string\",\n \"project_id\": \"fdcb96f2-67f6-4a40-4d9a-795d9c658f99\",\n \"status\": \"string\",\n \"stage\": \"string\",\n \"cost\": 3995.0677799191535,\n \"duration\": 2280.9755319799997,\n \"width\": 3010,\n \"height\": 6278,\n \"fps\": 163,\n \"output_url\": \"https://RCVOtoiNmwLXOxqw.yvokV9wHe6TEU0PyHZXEkesSxCfNHe53l\",\n \"output_size_bytes\": 1649,\n \"error\": \"string\",\n \"progress_percent\": 7103,\n \"sprite_url\": \"https://sMDixSVngVZWnOl.pciJ+rI,YrhSJ4bCVNObOPM,B8DkOlfGG9HAeynAWFRs,e,vaMIgk9FJ8c8PPuQ0FeBsHkQ\",\n \"video_json\": {},\n \"outputs\": [\n {\n \"id\": \"0f964d69-c83d-4a86-a6ff-53b7c72830a8\",\n \"integration_id\": \"e08f7362-a6ad-497e-fce1-ce90f3a3dc30\",\n \"provider\": \"string\",\n \"output_key\": \"string\",\n \"output_url\": \"http://WZDrfhMBxQcCNsTSDYD.sstfv6aLptSxVkW9F60Yr3w,-qU6DnRMPINEElg.KSY,oASzSpZd9mgjlhQCHWwKOUE1vI\",\n \"output_size_bytes\": 3215,\n \"status\": \"string\",\n \"error\": \"string\",\n \"created_at\": \"2023-03-24T04:53:54.639Z\",\n \"updated_at\": \"1965-06-29T11:15:45.111Z\"\n },\n {\n \"id\": \"34ff3d5b-2949-e1b6-85ce-db709e77c760\",\n \"integration_id\": \"2c9ccda4-abc9-0e81-b726-8b27c2c88f58\",\n \"provider\": \"string\",\n \"output_key\": \"string\",\n \"output_url\": \"http://BIvTawIVXb.fuZ.Jkmqx,Ca4tHTauDrp1iz0Q737-\",\n \"output_size_bytes\": 397,\n \"status\": \"string\",\n \"error\": \"string\",\n \"created_at\": \"1991-03-11T02:16:32.758Z\",\n \"updated_at\": \"2002-03-28T14:33:13.865Z\"\n }\n ],\n \"projects\": {},\n \"created_at\": \"2008-10-04T02:51:12.002Z\",\n \"completed_at\": \"2008-02-28T21:19:19.636Z\"\n }\n ],\n \"total\": 2244,\n \"page\": 3996,\n \"limit\": 1259,\n \"totalPages\": 6842\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebe07210-b17d-4e7d-bf43-8d6ac55611c7", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "renditions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "25" }, { "key": "sortBy", "value": "created_at" }, { "key": "sortOrder", "value": "desc" }, { "key": "status", "value": "" }, { "key": "search", "value": "" }, { "key": "from", "value": "" }, { "key": "to", "value": "" }, { "key": "projectId", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9de2943a-c4d6-4a2c-a118-c3f5240a3cf6", "name": "Get render statistics", "request": { "name": "Get render statistics", "description": {}, "url": { "path": [ "v1", "renditions", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0024dd84-c26a-4c80-b820-9bbed7da2026", "name": "Status counts", "originalRequest": { "url": { "path": [ "v1", "renditions", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 9052,\n \"completed\": 6679,\n \"failed\": 6483,\n \"processing\": 2978,\n \"queued\": 6226,\n \"rendering\": 2100\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dea624d5-efdc-4e0d-a7a7-0aeb6aa342b7", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "renditions", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a97697c-d642-4d62-a648-3f06437907f1", "name": "Get a single rendition", "request": { "name": "Get a single rendition", "description": {}, "url": { "path": [ "v1", "renditions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "65baa57f-4ffb-4254-a953-21086e9b9c49", "name": "Rendition details", "originalRequest": { "url": { "path": [ "v1", "renditions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rendition\": {\n \"id\": \"737ad4dd-9948-fdd2-c1bb-cbd795f7ea0d\",\n \"job_id\": \"string\",\n \"project_id\": \"5b7b222a-8fa7-0e70-b5d4-3c7afaad8891\",\n \"status\": \"string\",\n \"stage\": \"string\",\n \"cost\": 7450.788426101917,\n \"duration\": 9506.433714007682,\n \"width\": 2416,\n \"height\": 5216,\n \"fps\": 4641,\n \"output_url\": \"http://nTGejQNnXpteBF.mcdkuworUMj4h5Bru,MtIaK+scdtJTMkNCpxMN3oH53yKgd,ZQd1xPmVxsYCp6sEQER\",\n \"output_size_bytes\": 5315,\n \"error\": \"string\",\n \"progress_percent\": 2684,\n \"sprite_url\": \"http://iEw.pjshFhOpabOAy,Pz-k0Yy2tMXSz+pH24tDm-H+W5URMUSV4hXx3QtuM-QfQFzTrDDcqubWw+M+5PAHeUgt5eULoAOOa4vstg20\",\n \"video_json\": {},\n \"outputs\": [\n {\n \"id\": \"3a421ba7-8fb8-a5bc-5cf2-b0002cda6d82\",\n \"integration_id\": \"120a3ee0-1e72-bccf-5eb2-70d4186d623b\",\n \"provider\": \"string\",\n \"output_key\": \"string\",\n \"output_url\": \"http://gZxFdfwkDdacSsUEOlfolJLhpYGdK.oykvmIsxeKHW7BPd8u+QZ,aE10Du\",\n \"output_size_bytes\": 6064,\n \"status\": \"string\",\n \"error\": \"string\",\n \"created_at\": \"1947-10-06T10:07:13.505Z\",\n \"updated_at\": \"2009-02-23T01:09:13.245Z\"\n },\n {\n \"id\": \"876de5cf-42d1-63ff-b97c-0c2332659f73\",\n \"integration_id\": \"e399d9e8-0fd6-39c0-30c7-2ab46623f985\",\n \"provider\": \"string\",\n \"output_key\": \"string\",\n \"output_url\": \"https://uxT.knqL..ARDXsdH8M-u9z1rnwWQL24j-N4,oru3CsiuVhb89SomM4u-2hoyXr\",\n \"output_size_bytes\": 5355,\n \"status\": \"string\",\n \"error\": \"string\",\n \"created_at\": \"2016-10-05T11:09:35.704Z\",\n \"updated_at\": \"1954-11-26T12:37:53.965Z\"\n }\n ],\n \"projects\": {},\n \"created_at\": \"2022-05-04T23:36:38.047Z\",\n \"completed_at\": \"1971-08-12T21:40:06.577Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd679db7-2800-40ff-89ba-8e8f4519c424", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "renditions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc80d8b3-8765-4737-944e-42429f5b4f5f", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "renditions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4d26c874-b5ce-4557-be57-ad94eed02079", "name": "Delete a rendition", "request": { "name": "Delete a rendition", "description": {}, "url": { "path": [ "v1", "renditions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5e3eccdf-d0ca-4dce-bbbb-761d6232bbb4", "name": "Deleted successfully", "originalRequest": { "url": { "path": [ "v1", "renditions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"deleted\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "433af129-8e81-4cab-bded-dbea24ae34a1", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "renditions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3677f743-065f-4bee-a915-76486c1287b6", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "renditions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3160c950-a28a-4480-9f6d-865ef812acbc", "name": "Cancel a rendition", "request": { "name": "Cancel a rendition", "description": {}, "url": { "path": [ "v1", "renditions", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "19c57a63-7a7b-4d79-a082-46702be2637d", "name": "Cancellation result", "originalRequest": { "url": { "path": [ "v1", "renditions", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"2534df8b-f3f2-8312-a869-b89fca387425\",\n \"status\": \"string\",\n \"refunded\": 3682.0001652797528,\n \"jobId\": \"string\",\n \"error\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5d83fd6-23b5-49bf-b4ab-3251b00c3e29", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "renditions", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "871490f6-ab5d-4c08-ac20-c5106b1f9ee7", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "renditions", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e8200ed-2d63-4236-86c8-e02bbe8ea567", "name": "Rendition already terminal", "originalRequest": { "url": { "path": [ "v1", "renditions", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2e1ed95-04eb-4c43-810d-2e8830c76b2f", "name": "Bulk delete renditions", "request": { "name": "Bulk delete renditions", "description": {}, "url": { "path": [ "v1", "renditions", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "53edba4e-5919-454e-b096-9cec4d855917", "name": "Deleted renditions", "originalRequest": { "url": { "path": [ "v1", "renditions", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 2866,\n \"deleted\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "163cee67-8ee1-44b7-8f51-c47a1cf3a69a", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "renditions", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64f3143f-67e1-432c-aa52-7b9f23000b46", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "renditions", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c9b8e245-b016-49d0-bafb-d35470dcb8a0", "name": "Webhooks", "description": { "content": "Manage outbound webhook subscriptions and receive signed render events.", "type": "text/plain" }, "item": [ { "id": "ed75ea44-c745-4e05-b98f-8707f21c103e", "name": "Create a webhook subscription", "request": { "name": "Create a webhook subscription", "description": {}, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fe0086c9-f9a9-4648-b39f-50f3c458c3d5", "name": "Subscription created", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cf353539-8884-ccee-7e99-3b503cae6ac3\",\n \"url\": \"http://JTpaCQjPw.joRFeIVdarXOSyhEcCZ6oM9gM6LuHKEpbY\",\n \"events\": [\n \"render.failed\",\n \"render.failed\"\n ],\n \"secret\": \"string\",\n \"createdAt\": \"2013-09-05T23:37:16.634Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "918cb19f-18ff-4fd0-b29b-08a8ea7e3a37", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f244d1f-13ac-4326-adb7-7d6eda5dfa40", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97aa8c4d-7c8e-46c4-93f2-7a3b9ff2c509", "name": "Maximum subscriptions reached", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "025261ac-9f4c-40ed-8e30-df393dc38015", "name": "List webhook subscriptions", "request": { "name": "List webhook subscriptions", "description": {}, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d8043b90-275e-440e-a46b-f6840e982daa", "name": "Active subscriptions", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscriptions\": [\n {\n \"id\": \"d963aa78-682c-6116-9e33-e3d98037c324\",\n \"url\": \"https://RgIVEvwngnMDnCkguXOfzNeYmJ.gnLm7h+kbFKbwveilE6StAZ7gTuEGpa2QsZH\",\n \"events\": [\n \"render.failed\",\n \"render.failed\"\n ],\n \"secret\": \"string\",\n \"createdAt\": \"2002-02-21T16:09:14.247Z\"\n },\n {\n \"id\": \"4bddde47-b18b-1c82-1d75-243b07793018\",\n \"url\": \"https://tlFAOKvuqaPYzTkyzAXEUqEvuje.duzI7uXpcNuZ088s-QQ9nbrwcNQjsaH0iD2wibUcLZInHJJiP\",\n \"events\": [\n \"render.completed\",\n \"render.completed\"\n ],\n \"secret\": \"string\",\n \"createdAt\": \"1964-10-18T17:42:17.671Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce73de16-3ec8-4296-b826-ab192462e3fa", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee10df1e-3d13-4211-b988-0ce4d59bd023", "name": "Revoke a webhook subscription", "request": { "name": "Revoke a webhook subscription", "description": {}, "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "05acfcff-66b2-4cac-a7a8-76d1ba67b706", "name": "Subscription revoked", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5077466f-70d9-4404-92f4-57c6133c7687", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a38c7a1-f6f5-47f6-99b8-14214a2a3ca6", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "861b5247-be67-469f-bb5f-df1fec3905a9", "name": "Workflows", "description": { "content": "Automation workflows for video pipelines", "type": "text/plain" }, "item": [ { "id": "2734b7ba-bb6e-416b-af5a-80732476d26f", "name": "List available workflow step types", "request": { "name": "List available workflow step types", "description": {}, "url": { "path": [ "v1", "workflows", "step-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "85583bde-ed37-447e-a635-6a4a9886cc2f", "name": "Step types", "originalRequest": { "url": { "path": [ "v1", "workflows", "step-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"stepTypes\": []\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d094acdf-de5d-4251-8423-7df6513f439e", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "workflows", "step-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b472c5f7-26a0-45b4-a189-356d23a05d64", "name": "List workflows", "request": { "name": "List workflows", "description": {}, "url": { "path": [ "v1", "workflows" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "2704cc75-c372-4f9b-b451-dbb06f5f41ba", "name": "Workflows", "originalRequest": { "url": { "path": [ "v1", "workflows" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"workflows\": [\n {\n \"id\": \"0c3cd250-5b0f-3e12-2cb7-9182c8340ac7\",\n \"workspaceId\": \"88d0ccbf-af12-9a2f-97be-64b787c2c883\",\n \"createdBy\": \"92cb6543-d129-634d-1522-66ba2f771181\",\n \"name\": \"string\",\n \"definition\": {\n \"version\": 1,\n \"variables\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"steps\": [\n {\n \"type\": \"apply_tool\",\n \"config\": {\n \"key_0\": 5693\n },\n \"name\": \"string\",\n \"maxRetries\": 1\n }\n ]\n },\n \"isActive\": true,\n \"createdAt\": \"1948-10-10T01:02:07.849Z\",\n \"updatedAt\": \"1959-05-29T15:24:43.626Z\",\n \"description\": \"string\"\n },\n {\n \"id\": \"e1e7e9a8-bad2-ebb9-5596-c2ee5b10f42e\",\n \"workspaceId\": \"9109f12a-876a-0016-3e4a-3f3c119255cd\",\n \"createdBy\": \"06bb15e8-bafd-de99-d13d-3b1efea3cdc8\",\n \"name\": \"string\",\n \"definition\": {\n \"version\": 1,\n \"variables\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"steps\": [\n {\n \"type\": \"crawl_url\",\n \"config\": {\n \"key_0\": false,\n \"key_1\": 7890.89055662863\n },\n \"name\": \"string\",\n \"maxRetries\": 7\n }\n ]\n },\n \"isActive\": false,\n \"createdAt\": \"2013-03-27T12:48:33.985Z\",\n \"updatedAt\": \"1954-07-31T11:41:25.077Z\",\n \"description\": \"string\"\n }\n ],\n \"total\": 8463,\n \"page\": 6319,\n \"limit\": 6446,\n \"totalPages\": 2544\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a259568c-27bf-487b-b369-363c97eeef6c", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "workflows" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a0eaaba5-c001-4dc1-bb9e-8e0effcb6467", "name": "Create a workflow", "request": { "name": "Create a workflow", "description": {}, "url": { "path": [ "v1", "workflows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"definition\": {\n \"version\": \"\",\n \"variables\": {\n \"key_0\": {}\n },\n \"steps\": [\n {\n \"type\": \"\",\n \"config\": {\n \"key_0\": true\n },\n \"name\": \"\",\n \"maxRetries\": \"\"\n }\n ]\n },\n \"description\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "50df5a61-50b3-447b-92eb-ff1a18e21b94", "name": "Workflow created", "originalRequest": { "url": { "path": [ "v1", "workflows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"definition\": {\n \"version\": \"\",\n \"variables\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"steps\": [\n {\n \"type\": \"\",\n \"config\": {\n \"key_0\": 8413\n },\n \"name\": \"\",\n \"maxRetries\": \"\"\n }\n ]\n },\n \"description\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"workflow\": {\n \"id\": \"f64d133f-ba4f-315a-279c-20b3c2e4d69d\",\n \"workspaceId\": \"c73600aa-d9e5-8dca-d63c-3bb08107608b\",\n \"createdBy\": \"06c1f6af-32a0-47a8-03aa-4affd1883942\",\n \"name\": \"string\",\n \"definition\": {\n \"version\": \"\",\n \"variables\": {\n \"key_0\": {}\n },\n \"steps\": [\n {\n \"type\": \"\",\n \"config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"name\": \"\",\n \"maxRetries\": \"\"\n }\n ]\n },\n \"isActive\": true,\n \"createdAt\": \"1963-11-08T20:41:24.102Z\",\n \"updatedAt\": \"1974-02-09T11:35:41.892Z\",\n \"description\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5c45d70-27c1-43c6-acc7-342cfaac24f6", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "workflows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"definition\": {\n \"version\": \"\",\n \"variables\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"steps\": [\n {\n \"type\": \"\",\n \"config\": {\n \"key_0\": 8413\n },\n \"name\": \"\",\n \"maxRetries\": \"\"\n }\n ]\n },\n \"description\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7292f44b-4c34-4945-9dea-081054a51c19", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "workflows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"definition\": {\n \"version\": \"\",\n \"variables\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"steps\": [\n {\n \"type\": \"\",\n \"config\": {\n \"key_0\": 8413\n },\n \"name\": \"\",\n \"maxRetries\": \"\"\n }\n ]\n },\n \"description\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0666789-c292-47eb-a611-1b8dee0b96a0", "name": "Get a workflow", "request": { "name": "Get a workflow", "description": {}, "url": { "path": [ "v1", "workflows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "253f7606-df62-4087-92ab-aa5153aa8a14", "name": "Workflow details", "originalRequest": { "url": { "path": [ "v1", "workflows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"workflow\": {\n \"id\": \"b1eca4b7-8222-3030-56b4-3475ea4d7281\",\n \"workspaceId\": \"1e4c7ace-7ce0-3409-4668-26617aab3f3e\",\n \"createdBy\": \"9ca5f505-b98c-3c41-193c-5b7b2518d664\",\n \"name\": \"string\",\n \"definition\": {\n \"version\": \"\",\n \"variables\": {\n \"key_0\": {}\n },\n \"steps\": [\n {\n \"type\": \"\",\n \"config\": {\n \"key_0\": \"string\"\n },\n \"name\": \"\",\n \"maxRetries\": \"\"\n }\n ]\n },\n \"isActive\": false,\n \"createdAt\": \"1995-03-20T21:03:06.571Z\",\n \"updatedAt\": \"1988-07-31T06:41:03.820Z\",\n \"description\": \"string\"\n },\n \"recentRuns\": [\n {\n \"id\": \"79592965-2f46-5195-618e-2a66bc0eeb89\",\n \"workflowId\": \"454e8996-11ca-bb91-e58f-2623fb7bbbd8\",\n \"workspaceId\": \"cf8c7766-146b-a3d9-9e96-a150153c09da\",\n \"status\": \"string\",\n \"trigger\": \"string\",\n \"variables\": {},\n \"triggeredBy\": \"f9ce686c-d4be-4c73-5879-1710cad56f26\",\n \"estimatedCost\": 9905.784079673233,\n \"totalCost\": 5013.691628692633,\n \"error\": \"string\",\n \"startedAt\": \"1967-01-22T06:17:39.806Z\",\n \"completedAt\": \"1960-03-20T06:09:07.932Z\",\n \"createdAt\": \"1967-11-26T13:51:16.290Z\",\n \"updatedAt\": \"1957-11-24T02:14:03.728Z\"\n },\n {\n \"id\": \"d2f7951e-cd0a-bef0-7b2a-5f4123eb41e5\",\n \"workflowId\": \"66522e1c-d423-dd0e-0833-f6a8e93076bc\",\n \"workspaceId\": \"497fd0fd-184a-b9ef-6521-6bcfee3a07d4\",\n \"status\": \"string\",\n \"trigger\": \"string\",\n \"variables\": {},\n \"triggeredBy\": \"6ee25bbd-1517-1e85-241f-01c19e7a02aa\",\n \"estimatedCost\": 347.7192338750357,\n \"totalCost\": 1585.640171583853,\n \"error\": \"string\",\n \"startedAt\": \"2015-03-12T03:37:13.508Z\",\n \"completedAt\": \"1973-05-18T04:50:26.151Z\",\n \"createdAt\": \"2003-06-06T23:15:36.516Z\",\n \"updatedAt\": \"1977-11-27T16:02:02.382Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46f72f0c-f36d-4205-8a67-651399909905", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "workflows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "143170e1-8d8e-4e54-b69c-4afc9f39fd31", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "workflows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e98cdcf-5814-42e9-b234-5f04d6770195", "name": "Update a workflow", "request": { "name": "Update a workflow", "description": {}, "url": { "path": [ "v1", "workflows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"definition\": {\n \"version\": \"\",\n \"variables\": {\n \"key_0\": {}\n },\n \"steps\": [\n {\n \"type\": \"\",\n \"config\": {\n \"key_0\": 8736\n },\n \"name\": \"\",\n \"maxRetries\": \"\"\n }\n ]\n },\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f4c69783-1706-415d-8c31-f85fe27a0399", "name": "Workflow updated", "originalRequest": { "url": { "path": [ "v1", "workflows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"definition\": {\n \"version\": \"\",\n \"variables\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"steps\": [\n {\n \"type\": \"\",\n \"config\": {\n \"key_0\": 2586\n },\n \"name\": \"\",\n \"maxRetries\": \"\"\n }\n ]\n },\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"workflow\": {\n \"id\": \"f64d133f-ba4f-315a-279c-20b3c2e4d69d\",\n \"workspaceId\": \"c73600aa-d9e5-8dca-d63c-3bb08107608b\",\n \"createdBy\": \"06c1f6af-32a0-47a8-03aa-4affd1883942\",\n \"name\": \"string\",\n \"definition\": {\n \"version\": \"\",\n \"variables\": {\n \"key_0\": {}\n },\n \"steps\": [\n {\n \"type\": \"\",\n \"config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"name\": \"\",\n \"maxRetries\": \"\"\n }\n ]\n },\n \"isActive\": true,\n \"createdAt\": \"1963-11-08T20:41:24.102Z\",\n \"updatedAt\": \"1974-02-09T11:35:41.892Z\",\n \"description\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "176fdb6f-33d6-40ae-83b1-cd1912db3a94", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "workflows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"definition\": {\n \"version\": \"\",\n \"variables\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"steps\": [\n {\n \"type\": \"\",\n \"config\": {\n \"key_0\": 2586\n },\n \"name\": \"\",\n \"maxRetries\": \"\"\n }\n ]\n },\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00ad877b-a55b-4a2c-a584-c295bdc0ce46", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "workflows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"definition\": {\n \"version\": \"\",\n \"variables\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"steps\": [\n {\n \"type\": \"\",\n \"config\": {\n \"key_0\": 2586\n },\n \"name\": \"\",\n \"maxRetries\": \"\"\n }\n ]\n },\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c070a0c-492d-4360-8a11-ab343faca150", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "workflows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"definition\": {\n \"version\": \"\",\n \"variables\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"steps\": [\n {\n \"type\": \"\",\n \"config\": {\n \"key_0\": 2586\n },\n \"name\": \"\",\n \"maxRetries\": \"\"\n }\n ]\n },\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae001708-4a11-4a6e-bb53-cbda119c7748", "name": "Delete a workflow", "request": { "name": "Delete a workflow", "description": {}, "url": { "path": [ "v1", "workflows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "2c0a3ce5-0f29-4c87-8a0a-b7623eb00a81", "name": "Workflow deleted", "originalRequest": { "url": { "path": [ "v1", "workflows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bad85f96-e056-48a7-8565-f1027cbb019c", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "workflows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37342718-e60f-4b44-8485-66642e6642d2", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "workflows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20616681-5adb-4bad-8cb3-3c60572e4cd4", "name": "Run a workflow", "request": { "name": "Run a workflow", "description": {}, "url": { "path": [ "v1", "workflows", ":id", "run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"variables\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": \"string\",\n \"key_3\": \"string\",\n \"key_4\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8fd276c4-84d2-411c-afba-8ae2b05eeaf3", "name": "Workflow run started", "originalRequest": { "url": { "path": [ "v1", "workflows", ":id", "run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"variables\": {\n \"key_0\": \"string\",\n \"key_1\": 3092.5928523046387,\n \"key_2\": 4191.605054266773\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"run\": {\n \"id\": \"4e1d9e51-136a-692e-ce54-bb0942ad67d2\",\n \"workflowId\": \"737b31d5-6767-5b3f-c948-b24d2b29ca96\",\n \"workspaceId\": \"39ad99ba-3eb5-8de7-af69-96422130bf75\",\n \"status\": \"string\",\n \"trigger\": \"string\",\n \"variables\": {},\n \"triggeredBy\": \"5e8ecb03-4780-6459-dd6b-5c65037dacd9\",\n \"estimatedCost\": 8603.95302027299,\n \"totalCost\": 7660.497126182021,\n \"error\": \"string\",\n \"startedAt\": \"2000-07-09T18:10:24.505Z\",\n \"completedAt\": \"1989-09-11T00:19:15.416Z\",\n \"createdAt\": \"1998-08-27T18:53:18.124Z\",\n \"updatedAt\": \"2005-12-14T05:02:09.939Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4914402-0c6d-4a4d-876a-2bca7345b2ad", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "workflows", ":id", "run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"variables\": {\n \"key_0\": \"string\",\n \"key_1\": 3092.5928523046387,\n \"key_2\": 4191.605054266773\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc732b90-a746-4b69-b95f-9ca2355dcb4c", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "workflows", ":id", "run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"variables\": {\n \"key_0\": \"string\",\n \"key_1\": 3092.5928523046387,\n \"key_2\": 4191.605054266773\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98d04640-9b48-48f5-8e02-2a94acd71127", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "workflows", ":id", "run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"variables\": {\n \"key_0\": \"string\",\n \"key_1\": 3092.5928523046387,\n \"key_2\": 4191.605054266773\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e8f1c4d3-0ccb-4eb3-aac3-70b204f70825", "name": "List workflow runs", "request": { "name": "List workflow runs", "description": {}, "url": { "path": [ "v1", "workflows", ":id", "runs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "628d487d-f916-4d92-a10b-c0f45f36b4d1", "name": "Workflow runs", "originalRequest": { "url": { "path": [ "v1", "workflows", ":id", "runs" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"runs\": [\n {\n \"id\": \"ce0d0249-7c32-6975-b99e-a6ed223a70ea\",\n \"workflowId\": \"9edc4924-5816-7cbe-9424-41a99c67ba1b\",\n \"workspaceId\": \"2af05aae-3d2e-8fe3-8e78-2f11dc4def6d\",\n \"status\": \"string\",\n \"trigger\": \"string\",\n \"variables\": {},\n \"triggeredBy\": \"09b62f09-7345-cc64-b8e2-4de940511462\",\n \"estimatedCost\": 6235.719877943959,\n \"totalCost\": 5942.052984121819,\n \"error\": \"string\",\n \"startedAt\": \"2014-11-20T17:39:11.341Z\",\n \"completedAt\": \"1972-07-26T08:31:35.394Z\",\n \"createdAt\": \"1971-04-14T02:52:19.410Z\",\n \"updatedAt\": \"1953-03-11T07:06:38.112Z\"\n },\n {\n \"id\": \"9705948d-4a6d-ab2d-93df-a6d096b7caf8\",\n \"workflowId\": \"f42adefa-70f9-3838-71e9-9adcc8f56820\",\n \"workspaceId\": \"bb36a68b-5f21-572c-a708-86fae45a2383\",\n \"status\": \"string\",\n \"trigger\": \"string\",\n \"variables\": {},\n \"triggeredBy\": \"ff0f928a-45d6-7dea-0189-49834756c0e3\",\n \"estimatedCost\": 8115.436501549682,\n \"totalCost\": 3584.423969481686,\n \"error\": \"string\",\n \"startedAt\": \"2006-11-05T14:01:54.800Z\",\n \"completedAt\": \"1985-02-22T11:46:04.868Z\",\n \"createdAt\": \"1958-07-07T21:36:46.856Z\",\n \"updatedAt\": \"2012-03-17T00:26:26.589Z\"\n }\n ],\n \"total\": 3126,\n \"page\": 7875,\n \"limit\": 2956,\n \"totalPages\": 762\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e9f30b5-2409-4826-96aa-3d5a406bd063", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "workflows", ":id", "runs" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7122791f-1a6f-4986-ab50-60fc5d6c09d6", "name": "Get a workflow run", "request": { "name": "Get a workflow run", "description": {}, "url": { "path": [ "v1", "workflows", "runs", ":runId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5accade1-8f82-4bb1-92d9-651a1da9e79c", "name": "Workflow run details", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"run\": {\n \"id\": \"9bd336d6-a70d-3fe3-c261-12f761cd78b1\",\n \"workflowId\": \"21985d6a-814b-cbf4-9add-87973b1be4b4\",\n \"workspaceId\": \"54dd89c9-b753-486b-9dbc-e8d4d2ba4e2e\",\n \"status\": \"string\",\n \"trigger\": \"string\",\n \"variables\": {},\n \"triggeredBy\": \"e3609c44-da4c-66d3-ce5b-827cf192343b\",\n \"estimatedCost\": 946.9432325072469,\n \"totalCost\": 7504.806152325785,\n \"error\": \"string\",\n \"startedAt\": \"2017-06-06T16:55:44.675Z\",\n \"completedAt\": \"2002-04-30T21:33:02.644Z\",\n \"createdAt\": \"2005-10-26T09:59:58.199Z\",\n \"updatedAt\": \"1996-05-17T19:52:05.771Z\"\n },\n \"steps\": [\n {\n \"id\": \"e70c2af5-cb23-932f-5fba-2175c895276e\",\n \"workflowRunId\": \"5a77cb9f-7ae4-a8bf-488f-202bc428c607\",\n \"stepIndex\": 3205,\n \"stepType\": \"string\",\n \"name\": \"string\",\n \"config\": {},\n \"status\": \"string\",\n \"inputUrl\": \"https://XyxXJqUypDshNQgtiVwfNbcUz.pfvF+n56aWzaOf3dA.QN6aATm9RIet\",\n \"outputUrl\": \"https://RgFQpooxcTGlSywR.ablgYz2fczpXpc0G-vKgMvogqs0MzAh1CZ\",\n \"outputKey\": \"string\",\n \"renditionId\": \"https://t.jwdclhd08JPm0vI5nXlZae1uoc.D196OMQpqrQS1PDuSw5ttpKMpS1V5ypcxqt0Uf\",\n \"error\": \"string\",\n \"responseStatus\": 3512,\n \"metadata\": {},\n \"retryCount\": 93,\n \"maxRetries\": 3972,\n \"startedAt\": \"2003-04-08T14:18:56.301Z\",\n \"completedAt\": \"1993-08-22T13:12:54.429Z\",\n \"createdAt\": \"2004-07-04T15:59:57.765Z\",\n \"updatedAt\": \"2023-03-01T07:50:12.602Z\"\n },\n {\n \"id\": \"90807698-c75b-13fb-20a8-d0acb87ad6c7\",\n \"workflowRunId\": \"d476ef70-f3a2-d02f-be0c-03178bc2b025\",\n \"stepIndex\": 9452,\n \"stepType\": \"string\",\n \"name\": \"string\",\n \"config\": {},\n \"status\": \"string\",\n \"inputUrl\": \"https://kFHtJViZq.clvxnysEun5PjzYgLq0Ghhl0ZLYyCykgIHm54VnyJIHXQgfxp-oB\",\n \"outputUrl\": \"https://ilDnzqZoSshCnRSXSHXXgZmsoYwBvQZ.yxdCXjI9CtWK9OO2woso-shsvdKRpZtUyFHGGf\",\n \"outputKey\": \"string\",\n \"renditionId\": \"http://AU.btlhpqdsu8IEGGmZ6nJAOPJpt0Epb4U0cWNkh95eOyHIrCncGjeqitPTOMP9VMv67xG\",\n \"error\": \"string\",\n \"responseStatus\": 6659,\n \"metadata\": {},\n \"retryCount\": 2842,\n \"maxRetries\": 5620,\n \"startedAt\": \"1956-09-06T09:08:12.180Z\",\n \"completedAt\": \"1990-11-30T20:36:39.141Z\",\n \"createdAt\": \"1965-02-22T18:52:56.897Z\",\n \"updatedAt\": \"2023-10-08T07:05:11.253Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e743260f-7b33-41fa-822e-973b88328811", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acf831c7-ab93-4257-8e87-a091f077934e", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2a927c01-f7b6-493d-b988-f57d5012cdfe", "name": "Cancel a workflow run", "request": { "name": "Cancel a workflow run", "description": {}, "url": { "path": [ "v1", "workflows", "runs", ":runId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6e0e40fa-1765-4240-8556-7c45524370a2", "name": "Run cancelled", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c51abad3-3b83-45d8-80ce-a6a6b28f7368", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a26ccbb6-f079-40b8-a11e-f070b407a552", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd70cdea-84a9-4de7-b9d3-4d74935adc66", "name": "Run cannot be cancelled", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf293cc0-e575-453e-a78b-67606df0af3d", "name": "Retry a workflow run", "request": { "name": "Retry a workflow run", "description": {}, "url": { "path": [ "v1", "workflows", "runs", ":runId", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c35f5f5a-226c-4f59-9b1e-50a2dd34b057", "name": "New run started", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"run\": {\n \"id\": \"4e1d9e51-136a-692e-ce54-bb0942ad67d2\",\n \"workflowId\": \"737b31d5-6767-5b3f-c948-b24d2b29ca96\",\n \"workspaceId\": \"39ad99ba-3eb5-8de7-af69-96422130bf75\",\n \"status\": \"string\",\n \"trigger\": \"string\",\n \"variables\": {},\n \"triggeredBy\": \"5e8ecb03-4780-6459-dd6b-5c65037dacd9\",\n \"estimatedCost\": 8603.95302027299,\n \"totalCost\": 7660.497126182021,\n \"error\": \"string\",\n \"startedAt\": \"2000-07-09T18:10:24.505Z\",\n \"completedAt\": \"1989-09-11T00:19:15.416Z\",\n \"createdAt\": \"1998-08-27T18:53:18.124Z\",\n \"updatedAt\": \"2005-12-14T05:02:09.939Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3885c8f-4a79-4b16-8aeb-daff51c29f80", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71cb1367-1314-4af7-8bb7-e9b5fd1dc4ec", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94ed987a-2e3f-461a-8e12-9cef21ddaf48", "name": "Retry a workflow step", "request": { "name": "Retry a workflow step", "description": {}, "url": { "path": [ "v1", "workflows", "runs", ":runId", "steps", ":stepId", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stepId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c36eca5d-e39d-4bb8-abf7-3e1283a8f255", "name": "Step retry requested", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId", "steps", ":stepId", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stepId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59ccc190-aad0-44a9-987c-388d9395fce4", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId", "steps", ":stepId", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stepId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2a4aff8-3afc-4679-88b3-0e11f7d2e688", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId", "steps", ":stepId", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stepId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccdbb34f-4ea0-443a-9785-114064016670", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId", "steps", ":stepId", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stepId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0428750b-0ec3-4b2b-a099-068f5320379e", "name": "Skip a workflow step", "request": { "name": "Skip a workflow step", "description": {}, "url": { "path": [ "v1", "workflows", "runs", ":runId", "steps", ":stepId", "skip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stepId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "529903c5-d741-4ac4-91ce-1201dd49afb9", "name": "Step skip requested", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId", "steps", ":stepId", "skip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stepId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff22aed4-504c-422d-8ba1-85342f926ac0", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId", "steps", ":stepId", "skip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stepId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e87d1b7c-dfd3-4c83-8341-0db74b10e159", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId", "steps", ":stepId", "skip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stepId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3db1bd8a-832a-45c5-b78e-3b9ea6a190e9", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "workflows", "runs", ":runId", "steps", ":stepId", "skip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "runId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stepId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ef2a29c0-f3e7-43f0-ad3d-781a81582f3b", "name": "Billing", "description": { "content": "Subscriptions, credits, and invoices", "type": "text/plain" }, "item": [ { "id": "fcc184a8-7057-4ad9-a04c-2294129a991a", "name": "List available prices", "request": { "name": "List available prices", "description": {}, "url": { "path": [ "billing", "prices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b283bd6a-bd6d-45fc-ba0e-43b2e3963fa0", "name": "Prices", "originalRequest": { "url": { "path": [ "billing", "prices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tiers\": {\n \"starter\": \"string\",\n \"pro\": \"string\",\n \"business\": \"string\"\n },\n \"credits\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "32bca248-ddd9-4e7f-8e2f-2ef5b39570c8", "name": "Create checkout session", "request": { "name": "Create checkout session", "description": {}, "url": { "path": [ "billing", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"tierId\": \"\",\n \"mode\": \"\",\n \"credits\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2f9dbc2a-74bf-4231-b2df-5537b128e596", "name": "Checkout session created", "originalRequest": { "url": { "path": [ "billing", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"tierId\": \"\",\n \"mode\": \"\",\n \"credits\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"url\": \"https://aYjjscpCQ.ivldL9aGAGeSBplS8AaWNYPK0LpFilNFJ8T8iBxEB,wscpFCixT4KA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1f62e52-1fbd-49d0-9bc2-3bd3d3d28abb", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "billing", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"tierId\": \"\",\n \"mode\": \"\",\n \"credits\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f193dc3-57b9-486a-8c77-de324430e0f4", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "billing", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"productId\": \"\",\n \"tierId\": \"\",\n \"mode\": \"\",\n \"credits\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "622636cd-6b04-4bb1-a3a9-b4353e67f9fb", "name": "Cancel active subscription", "request": { "name": "Cancel active subscription", "description": {}, "url": { "path": [ "billing", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "30d1c1ee-5cc7-4f8b-80be-e3b57f77c175", "name": "Cancellation scheduled", "originalRequest": { "url": { "path": [ "billing", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b55367b-dd77-4cde-bf64-6da2a04594ad", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "billing", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66ed4849-89bd-463f-b9ce-23b0cd57ba23", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "billing", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "524a9a06-04a2-4d5c-8b5a-599f83386cf5", "name": "List invoices", "request": { "name": "List invoices", "description": {}, "url": { "path": [ "billing", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "70ca6049-8b9b-430c-896a-fd0df4a18e8a", "name": "Invoices list", "originalRequest": { "url": { "path": [ "billing", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscription\": {\n \"status\": \"string\",\n \"currentPeriodEnd\": \"1976-10-28T18:59:42.721Z\",\n \"creditsBalance\": 5522.957537223232,\n \"creditsTotal\": 8473.995540433567,\n \"tier\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e6b14e2-e4cf-4b97-81cc-fc3cbf52d4e2", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "billing", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e84791d7-83fa-479d-bcec-110f53b66686", "name": "Get credit balance and history", "request": { "name": "Get credit balance and history", "description": {}, "url": { "path": [ "billing", "credits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a663491d-8d95-4668-b421-30c098ecf3d1", "name": "Credit balance", "originalRequest": { "url": { "path": [ "billing", "credits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"balance\": 2479.844410362,\n \"total\": 7283.501892635223,\n \"summary\": {\n \"purchased\": 9255.232710232953,\n \"consumed\": 8977.046312497738,\n \"refunded\": 8444.741841770545,\n \"consumed30Days\": 8138.985161624574\n },\n \"usage\": {\n \"storage\": {},\n \"bandwidth\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b45dd93b-b45f-4573-b29e-566bc954164e", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "billing", "credits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76aea1ed-e898-45f6-a27e-06ef71c1cc94", "name": "Get usage log history", "request": { "name": "Get usage log history", "description": {}, "url": { "path": [ "billing", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "30" }, { "disabled": false, "key": "type", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "81d4073d-58d6-4845-afa8-63664178138c", "name": "Usage logs", "originalRequest": { "url": { "path": [ "billing", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "30" }, { "key": "type", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"usage\": [\n {\n \"id\": \"e14082b8-8991-9c96-d318-8eb9d8d567b5\",\n \"type\": \"storage\",\n \"bytes\": 2222,\n \"source\": \"string\",\n \"created_at\": \"1948-10-22T20:38:47.184Z\",\n \"metadata\": {}\n },\n {\n \"id\": \"2b9594b9-2003-874f-432c-74e80f664d4f\",\n \"type\": \"storage\",\n \"bytes\": 2313,\n \"source\": \"string\",\n \"created_at\": \"2010-01-05T18:33:12.432Z\",\n \"metadata\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6f8a903-e64c-4b6a-9c43-45abb3b44f4e", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "billing", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "30" }, { "key": "type", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79b6c1b5-6c91-4573-9f42-d84790f18da7", "name": "Get subscription", "request": { "name": "Get subscription", "description": {}, "url": { "path": [ "billing", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "92d5e8ea-2f23-4071-9fc3-6737d8a68d74", "name": "Subscription details", "originalRequest": { "url": { "path": [ "billing", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscription\": {\n \"status\": \"string\",\n \"currentPeriodEnd\": \"1979-01-12T01:09:38.533Z\",\n \"creditsBalance\": 7234.746659662973,\n \"creditsTotal\": 366.4762583544567,\n \"tier\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a341e29-1975-4559-80c2-01356479a509", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "billing", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e2c1491d-f358-4d8d-8d9e-13e5c137491b", "name": "Integrations", "description": { "content": "Workspace storage integrations and destinations", "type": "text/plain" }, "item": [ { "id": "d30cfcf2-4aaf-4372-a1cd-cd9829e59a57", "name": "List workspace storage integrations", "request": { "name": "List workspace storage integrations", "description": {}, "url": { "path": [ "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4143a9c3-13c1-42f2-adb6-15d372f3a746", "name": "Integrations", "originalRequest": { "url": { "path": [ "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"integrations\": [\n {\n \"id\": \"4ec680aa-5a2b-331d-0a27-6638486a3503\",\n \"workspaceId\": \"0b43d762-5585-f5e4-528e-42f17eb8a09d\",\n \"provider\": \"r2\",\n \"name\": \"string\",\n \"isActive\": true,\n \"isDefault\": true,\n \"config\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 943\n },\n \"createdAt\": \"2010-04-05T00:41:47.710Z\",\n \"updatedAt\": \"1960-07-29T06:23:17.553Z\"\n },\n {\n \"id\": \"4e1c3365-879f-7801-a128-9ff4041eb811\",\n \"workspaceId\": \"88cedbec-4881-556b-3a09-280d2191a9d4\",\n \"provider\": \"azure\",\n \"name\": \"string\",\n \"isActive\": false,\n \"isDefault\": false,\n \"config\": {\n \"key_0\": true,\n \"key_1\": 8171\n },\n \"createdAt\": \"1988-04-30T17:36:45.659Z\",\n \"updatedAt\": \"2019-07-26T20:05:34.808Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de7017b6-5434-4d6c-9ba9-9e26fb668bc5", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "082eb4e2-2263-4c5b-acbe-46f0abd37bfe", "name": "Create a workspace integration", "request": { "name": "Create a workspace integration", "description": {}, "url": { "path": [ "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": 4162\n },\n \"isActive\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1455c4f3-b8e3-42fd-a4a8-54ed9694f46e", "name": "Integration created", "originalRequest": { "url": { "path": [ "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": 8615\n },\n \"isActive\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"integration\": {\n \"id\": \"eb62905e-dbbc-4eac-a4c6-f0c8b079d386\",\n \"workspaceId\": \"e0da1ca7-ca79-95ac-cc3b-4dd7b2afc044\",\n \"provider\": \"azure\",\n \"name\": \"string\",\n \"isActive\": true,\n \"isDefault\": false,\n \"config\": {\n \"key_0\": 3646\n },\n \"createdAt\": \"1950-04-21T15:06:27.056Z\",\n \"updatedAt\": \"2015-03-11T04:28:39.013Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef3df133-2589-4a65-9b25-dc6f8d0e482f", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": 8615\n },\n \"isActive\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cece4710-5c0e-4757-9145-d717c2e95ee7", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": 8615\n },\n \"isActive\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d84f2d2a-22ed-47d4-942b-ff35f27d5ecf", "name": "Update a workspace integration", "request": { "name": "Update a workspace integration", "description": {}, "url": { "path": [ "v1", "integrations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": 4162\n },\n \"isActive\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1cf00770-0703-4f64-8719-2c7943191916", "name": "Integration updated", "originalRequest": { "url": { "path": [ "v1", "integrations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": 8615\n },\n \"isActive\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"integration\": {\n \"id\": \"eb62905e-dbbc-4eac-a4c6-f0c8b079d386\",\n \"workspaceId\": \"e0da1ca7-ca79-95ac-cc3b-4dd7b2afc044\",\n \"provider\": \"azure\",\n \"name\": \"string\",\n \"isActive\": true,\n \"isDefault\": false,\n \"config\": {\n \"key_0\": 3646\n },\n \"createdAt\": \"1950-04-21T15:06:27.056Z\",\n \"updatedAt\": \"2015-03-11T04:28:39.013Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d4a25b3-8f0c-4369-bc35-4567c9956e2a", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "integrations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": 8615\n },\n \"isActive\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c45c6814-d1f7-4d94-9460-85b0b66e8dc9", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "integrations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": 8615\n },\n \"isActive\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a374e2a-5801-4b07-a6e5-70861d7cf5c5", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "integrations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": 8615\n },\n \"isActive\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30c2aff2-ce52-44e2-8d9f-b597c55f2708", "name": "Delete a workspace integration", "request": { "name": "Delete a workspace integration", "description": {}, "url": { "path": [ "v1", "integrations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "905f94df-5101-4e97-8f8b-d2323516d1bf", "name": "Integration deleted", "originalRequest": { "url": { "path": [ "v1", "integrations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84669661-5a01-4cc6-a52a-3c8f387a3709", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "integrations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80705bb3-329e-4c84-8329-9cc8ab98f03a", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "integrations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58369da7-d195-4392-8f3e-aa71e70a833e", "name": "Test a workspace integration", "request": { "name": "Test a workspace integration", "description": {}, "url": { "path": [ "v1", "integrations", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f98e9d21-42db-40e6-8c0a-27a65cff5a7c", "name": "Test result", "originalRequest": { "url": { "path": [ "v1", "integrations", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"error\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50c19d6c-38b7-4f42-b4a1-0343c8e4cf55", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "integrations", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61f97e09-7c1c-4f67-9342-0deacea06845", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "integrations", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5721e5e5-5866-4620-b1d5-6d431baaa21a", "name": "Get default destination", "request": { "name": "Get default destination", "description": { "content": "Backwards-compatible single-destination endpoint.", "type": "text/plain" }, "url": { "path": [ "v1", "destination" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c8e72ec4-e330-42e0-aad5-ab96a2f97e83", "name": "Destination", "originalRequest": { "url": { "path": [ "v1", "destination" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"destination\": {\n \"id\": \"fd5bc7a6-fcf7-5627-f4b5-01312ed87c84\",\n \"provider\": \"b2\",\n \"bucket\": \"string\",\n \"accessKeyId\": \"string\",\n \"secretAccessKey\": \"string\",\n \"endpoint\": \"https://W.duwIGXESr1S\",\n \"region\": \"string\",\n \"publicUrl\": \"https://HoXHMfqMxXgZPqah.fikgZOPp5rp0oM2ARIUkppBeg2f.fpn3nIufHl08n2bC9ynX3ZjeoFOzU\",\n \"pathPrefix\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27143232-780d-41c3-b133-3c4a7c3e9610", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "destination" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43ca9f1e-589a-4206-bb14-7c4836151b16", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "destination" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "04a9ecf3-c99f-4ab2-b3a4-6ac69c058ef1", "name": "Set default destination", "request": { "name": "Set default destination", "description": { "content": "Backwards-compatible single-destination endpoint.", "type": "text/plain" }, "url": { "path": [ "v1", "destination" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"bucket\": \"\",\n \"accessKeyId\": \"\",\n \"secretAccessKey\": \"\",\n \"endpoint\": \"\",\n \"region\": \"\",\n \"publicUrl\": \"\",\n \"pathPrefix\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ed4f525b-49bf-4733-9780-a50a0b8e24eb", "name": "Destination updated", "originalRequest": { "url": { "path": [ "v1", "destination" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"bucket\": \"\",\n \"accessKeyId\": \"\",\n \"secretAccessKey\": \"\",\n \"endpoint\": \"\",\n \"region\": \"\",\n \"publicUrl\": \"\",\n \"pathPrefix\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"destination\": {\n \"id\": \"fd5bc7a6-fcf7-5627-f4b5-01312ed87c84\",\n \"provider\": \"b2\",\n \"bucket\": \"string\",\n \"accessKeyId\": \"string\",\n \"secretAccessKey\": \"string\",\n \"endpoint\": \"https://W.duwIGXESr1S\",\n \"region\": \"string\",\n \"publicUrl\": \"https://HoXHMfqMxXgZPqah.fikgZOPp5rp0oM2ARIUkppBeg2f.fpn3nIufHl08n2bC9ynX3ZjeoFOzU\",\n \"pathPrefix\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "029eead3-f831-4949-908b-952c1af50d72", "name": "Destination created", "originalRequest": { "url": { "path": [ "v1", "destination" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"bucket\": \"\",\n \"accessKeyId\": \"\",\n \"secretAccessKey\": \"\",\n \"endpoint\": \"\",\n \"region\": \"\",\n \"publicUrl\": \"\",\n \"pathPrefix\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"destination\": {\n \"id\": \"fd5bc7a6-fcf7-5627-f4b5-01312ed87c84\",\n \"provider\": \"b2\",\n \"bucket\": \"string\",\n \"accessKeyId\": \"string\",\n \"secretAccessKey\": \"string\",\n \"endpoint\": \"https://W.duwIGXESr1S\",\n \"region\": \"string\",\n \"publicUrl\": \"https://HoXHMfqMxXgZPqah.fikgZOPp5rp0oM2ARIUkppBeg2f.fpn3nIufHl08n2bC9ynX3ZjeoFOzU\",\n \"pathPrefix\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0f33741-2c63-4f18-856a-916dbd5b3a26", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "destination" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"bucket\": \"\",\n \"accessKeyId\": \"\",\n \"secretAccessKey\": \"\",\n \"endpoint\": \"\",\n \"region\": \"\",\n \"publicUrl\": \"\",\n \"pathPrefix\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17ceb5c0-24a9-4bcd-bb29-688d45fe7614", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "destination" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"bucket\": \"\",\n \"accessKeyId\": \"\",\n \"secretAccessKey\": \"\",\n \"endpoint\": \"\",\n \"region\": \"\",\n \"publicUrl\": \"\",\n \"pathPrefix\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6acdb7a1-ed62-4654-a3fa-349289ce3051", "name": "Delete default destination", "request": { "name": "Delete default destination", "description": { "content": "Backwards-compatible single-destination endpoint.", "type": "text/plain" }, "url": { "path": [ "v1", "destination" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f121d9d3-f160-4dec-a7fd-e513522cdbb4", "name": "Destination deleted", "originalRequest": { "url": { "path": [ "v1", "destination" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfc6b0fb-e060-4baa-a18a-221d243aa39c", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "destination" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec5b80a2-f8c4-4979-b30a-2a3c6b0a7d23", "name": "Test default destination", "request": { "name": "Test default destination", "description": { "content": "Backwards-compatible single-destination test endpoint.", "type": "text/plain" }, "url": { "path": [ "v1", "destination", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"bucket\": \"\",\n \"accessKeyId\": \"\",\n \"secretAccessKey\": \"\",\n \"endpoint\": \"\",\n \"region\": \"\",\n \"publicUrl\": \"\",\n \"pathPrefix\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e0dea9a0-cbe5-4d8f-8a92-064457c4efc9", "name": "Test result", "originalRequest": { "url": { "path": [ "v1", "destination", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"bucket\": \"\",\n \"accessKeyId\": \"\",\n \"secretAccessKey\": \"\",\n \"endpoint\": \"\",\n \"region\": \"\",\n \"publicUrl\": \"\",\n \"pathPrefix\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"error\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc29406a-70e3-4540-9e4d-e30393a94fed", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "destination", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"bucket\": \"\",\n \"accessKeyId\": \"\",\n \"secretAccessKey\": \"\",\n \"endpoint\": \"\",\n \"region\": \"\",\n \"publicUrl\": \"\",\n \"pathPrefix\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d2f729d-e805-4e72-ab27-8b2dd75cba7c", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "destination", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"provider\": \"\",\n \"bucket\": \"\",\n \"accessKeyId\": \"\",\n \"secretAccessKey\": \"\",\n \"endpoint\": \"\",\n \"region\": \"\",\n \"publicUrl\": \"\",\n \"pathPrefix\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8e510657-8fb7-487f-8a68-48c5cc2db0f8", "name": "API Keys", "description": { "content": "Per-user API key management", "type": "text/plain" }, "item": [ { "id": "5ba9549e-64eb-49e9-bb1c-6e5ea5cf4fdc", "name": "List API keys", "request": { "name": "List API keys", "description": {}, "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8b10f8cd-ab74-4c15-90c0-e3470f18c36f", "name": "API keys", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"keys\": [\n {\n \"id\": \"aec3fe5a-9639-0d3a-c73d-fcbb5280ab78\",\n \"key_prefix\": \"string\",\n \"created_at\": \"1959-11-23T22:44:51.657Z\",\n \"name\": \"string\",\n \"last_used_at\": \"1946-09-27T05:26:48.716Z\",\n \"revoked_at\": \"2011-07-27T12:41:04.017Z\"\n },\n {\n \"id\": \"18d0270d-8cdf-5e52-658a-84fec9c6b12a\",\n \"key_prefix\": \"string\",\n \"created_at\": \"2018-06-05T07:47:15.504Z\",\n \"name\": \"string\",\n \"last_used_at\": \"1952-12-29T03:03:35.569Z\",\n \"revoked_at\": \"1949-03-21T17:00:14.369Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ca6d9bf-a4ab-4bf9-b840-c9700d17439c", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c0a618a6-5127-4ca0-95ea-37cbe8a399d2", "name": "Create an API key", "request": { "name": "Create an API key", "description": {}, "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1bb180d0-cd9d-40d1-92a5-23ad0f9f3057", "name": "API key created", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"string\",\n \"keyData\": {\n \"id\": \"112a8cbc-43eb-f67e-9d96-23f22ad8c5a9\",\n \"key_prefix\": \"string\",\n \"created_at\": \"1975-03-01T15:49:26.148Z\",\n \"name\": \"string\",\n \"last_used_at\": \"1960-04-20T08:04:50.300Z\",\n \"revoked_at\": \"1954-12-26T22:11:46.173Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41cc120c-284f-40dc-b50c-499c481f9166", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10fef315-11b6-4791-a3d1-16d379344db6", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f038bd2-1172-49c4-8b47-435490c7ab20", "name": "Delete an API key", "request": { "name": "Delete an API key", "description": {}, "url": { "path": [ "v1", "api-keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6ac78a51-4798-4766-a484-061abb162f90", "name": "API key deleted", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fe490a5-7643-48bd-a7a5-082e5f4312d4", "name": "Missing or invalid authentication", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e0f76e4-d00a-4242-8783-7bdb9f127bf3", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.ilovevideoeditor.com", "key": "baseUrl" }, { "key": "apiKey", "value": "", "type": "string", "description": "API key from the iLoveVideoEditor dashboard (vf_live_...)" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "info": { "_postman_id": "febc172a-0fc7-49d1-8933-cdb59fb2ff62", "name": "iLoveVideoEditor API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Official Postman collection for the **iLoveVideoEditor** cloud video rendering API — render videos programmatically from JSON. Describe a scene as VideoJSON (text, images, audio, video layers, animations, effects, transitions) or render a template with variables, queue a render job, and download the finished MP4/WebM. No servers, no FFmpeg, no infrastructure.\n\n**Quickstart**\n\n1. Fork this collection into your workspace.\n2. Set the `apiKey` collection variable to your API key from the iLoveVideoEditor dashboard (`vf_live_...`). `baseUrl` is preconfigured for production.\n3. Run **Render → Queue a render job** (`POST /v1/render`), poll **Get render status**, then download the video from the signed URL.\n\n**Authentication**\n\n- **API key** (`x-api-key` header) — render pipeline and tool endpoints; applied automatically via collection-level auth from the `apiKey` variable.\n- **Bearer JWT** (`Authorization: Bearer `) — user-scoped endpoints: projects, assets, billing, webhooks.\n\n**Resources**\n\n- Docs: https://ilovevideoeditor.com/docs · Interactive API reference: https://ilovevideoeditor.com/docs/api/ · OpenAPI spec: https://ilovevideoeditor.com/docs/api/openapi.yaml\n- SDKs for Node.js/TypeScript, Python, Ruby, PHP, and Go: https://ilovevideoeditor.com/docs/sdks" } }