{ "info": { "_postman_id": "085e88a3-8aa0-4cfc-8638-25ee138ca2e7", "name": "Mux API", "description": "Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.\n\nContact Support:\n Name: Mux DevEx\n Email: devex@mux.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:01:32.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "lastUpdatedBy": "35240", "uid": "35240-085e88a3-8aa0-4cfc-8638-25ee138ca2e7" }, "item": [ { "name": "video", "item": [ { "name": "v1", "item": [ { "name": "transcription-vocabularies", "item": [ { "name": "{TRANSCRIPTION_VOCABULARY_ID}", "item": [ { "name": "Retrieve a Transcription Vocabulary", "id": "90cd92f8-d714-4b4a-993d-b6c6a1ae69a7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/transcription-vocabularies/:TRANSCRIPTION_VOCABULARY_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "transcription-vocabularies", ":TRANSCRIPTION_VOCABULARY_ID" ], "variable": [ { "id": "44d7ef56-3b6a-4412-93c4-f1ccbe3396dd", "key": "TRANSCRIPTION_VOCABULARY_ID", "value": "", "description": "(Required) The ID of the Transcription Vocabulary." } ] }, "description": "Retrieves the details of a Transcription Vocabulary that has previously been created. Supply the unique Transcription Vocabulary ID and Mux will return the corresponding Transcription Vocabulary information. The same information is returned when creating a Transcription Vocabulary." }, "response": [ { "id": "8a60f347-4018-42e0-a2b8-7eb3ef10b72f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/transcription-vocabularies/:TRANSCRIPTION_VOCABULARY_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "transcription-vocabularies", ":TRANSCRIPTION_VOCABULARY_ID" ], "variable": [ { "key": "TRANSCRIPTION_VOCABULARY_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"name\": \"\",\n \"phrases\": [\n \"\",\n \"\"\n ],\n \"passthrough\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-8a60f347-4018-42e0-a2b8-7eb3ef10b72f" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-90cd92f8-d714-4b4a-993d-b6c6a1ae69a7" }, { "name": "Delete a Transcription Vocabulary", "id": "a33ae1fa-f854-470f-b42e-39f4de8b02cd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "https://api.mux.com/video/v1/transcription-vocabularies/:TRANSCRIPTION_VOCABULARY_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "transcription-vocabularies", ":TRANSCRIPTION_VOCABULARY_ID" ], "variable": [ { "id": "9bbed60c-064e-4a6a-b606-9e2d037a717a", "key": "TRANSCRIPTION_VOCABULARY_ID", "value": "", "description": "(Required) The ID of the Transcription Vocabulary." } ] }, "description": "Deletes a Transcription Vocabulary. The Transcription Vocabulary's ID will be disassociated from any live streams using it. Transcription Vocabularies can be deleted while associated live streams are active. However, the words and phrases in the deleted Transcription Vocabulary will remain attached to those streams while they are active." }, "response": [ { "id": "06c0c9fe-cdee-49af-8c87-1adfc63f5e26", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/transcription-vocabularies/:TRANSCRIPTION_VOCABULARY_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "transcription-vocabularies", ":TRANSCRIPTION_VOCABULARY_ID" ], "variable": [ { "key": "TRANSCRIPTION_VOCABULARY_ID" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-06c0c9fe-cdee-49af-8c87-1adfc63f5e26" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a33ae1fa-f854-470f-b42e-39f4de8b02cd" }, { "name": "Update a Transcription Vocabulary", "id": "fc813f8b-04d6-46a3-9a6f-5fbc2276087c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"phrases\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/transcription-vocabularies/:TRANSCRIPTION_VOCABULARY_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "transcription-vocabularies", ":TRANSCRIPTION_VOCABULARY_ID" ], "variable": [ { "id": "0284e341-05fb-4fc0-8195-c8f43711ec8c", "key": "TRANSCRIPTION_VOCABULARY_ID", "value": "", "description": "(Required) The ID of the Transcription Vocabulary." } ] }, "description": "Updates the details of a previously-created Transcription Vocabulary. Updates to Transcription Vocabularies are allowed while associated live streams are active. However, updates will not be applied to those streams while they are active." }, "response": [ { "id": "935bcb09-6186-496b-b284-a3538ca81040", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"phrases\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/transcription-vocabularies/:TRANSCRIPTION_VOCABULARY_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "transcription-vocabularies", ":TRANSCRIPTION_VOCABULARY_ID" ], "variable": [ { "key": "TRANSCRIPTION_VOCABULARY_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"name\": \"\",\n \"phrases\": [\n \"\",\n \"\"\n ],\n \"passthrough\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-935bcb09-6186-496b-b284-a3538ca81040" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-fc813f8b-04d6-46a3-9a6f-5fbc2276087c" } ], "id": "e75a896a-7dd0-4d04-9392-f05d69530d97", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e75a896a-7dd0-4d04-9392-f05d69530d97" }, { "name": "Create a Transcription Vocabulary", "id": "f41e8eb7-c426-4348-a0d7-530d322cb612", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"phrases\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/transcription-vocabularies", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "transcription-vocabularies" ] }, "description": "Create a new Transcription Vocabulary." }, "response": [ { "id": "de2eaba7-b3d9-4093-8253-cb73b1e339e1", "name": "Transcription Vocabulary Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"phrases\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/transcription-vocabularies", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "transcription-vocabularies" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"name\": \"\",\n \"phrases\": [\n \"\",\n \"\"\n ],\n \"passthrough\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-de2eaba7-b3d9-4093-8253-cb73b1e339e1" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f41e8eb7-c426-4348-a0d7-530d322cb612" }, { "name": "List Transcription Vocabularies", "id": "19b3a0f7-ee65-4d76-a9e0-d4733d25a66b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/transcription-vocabularies?limit=10&page=1", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "transcription-vocabularies" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "10" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" } ] }, "description": "List all Transcription Vocabularies." }, "response": [ { "id": "375af320-5509-4ccb-9e52-71dd581b23c6", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/transcription-vocabularies?limit=10&page=1", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "transcription-vocabularies" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "10" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"name\": \"\",\n \"phrases\": [\n \"\",\n \"\"\n ],\n \"passthrough\": \"\"\n },\n {\n \"id\": \"\",\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"name\": \"\",\n \"phrases\": [\n \"\",\n \"\"\n ],\n \"passthrough\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-375af320-5509-4ccb-9e52-71dd581b23c6" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-19b3a0f7-ee65-4d76-a9e0-d4733d25a66b" } ], "id": "32e98f60-0918-4813-98b5-e5d26706af76", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-32e98f60-0918-4813-98b5-e5d26706af76" }, { "name": "assets", "item": [ { "name": "{ASSET_ID}", "item": [ { "name": "input-info", "item": [ { "name": "Retrieve Asset Input Info", "id": "854a8e33-17de-4d30-ae27-d3d133994b0e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/input-info", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "input-info" ], "variable": [ { "id": "119e61c2-5c70-4f8a-9664-610d3220bab3", "key": "ASSET_ID", "value": "", "description": "(Required) The asset ID." } ] }, "description": "Returns a list of the input objects that were used to create the asset along with any settings that were applied to each input." }, "response": [ { "id": "ea7d2112-1aa2-4767-a7de-79f54eae1507", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/input-info", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "input-info" ], "variable": [ { "key": "ASSET_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"settings\": {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n \"file\": {\n \"container_format\": \"\",\n \"tracks\": [\n {\n \"type\": \"\",\n \"duration\": \"\",\n \"encoding\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"frame_rate\": \"\",\n \"sample_rate\": \"\",\n \"sample_size\": \"\",\n \"channels\": \"\"\n },\n {\n \"type\": \"\",\n \"duration\": \"\",\n \"encoding\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"frame_rate\": \"\",\n \"sample_rate\": \"\",\n \"sample_size\": \"\",\n \"channels\": \"\"\n }\n ]\n }\n },\n {\n \"settings\": {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n \"file\": {\n \"container_format\": \"\",\n \"tracks\": [\n {\n \"type\": \"\",\n \"duration\": \"\",\n \"encoding\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"frame_rate\": \"\",\n \"sample_rate\": \"\",\n \"sample_size\": \"\",\n \"channels\": \"\"\n },\n {\n \"type\": \"\",\n \"duration\": \"\",\n \"encoding\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"frame_rate\": \"\",\n \"sample_rate\": \"\",\n \"sample_size\": \"\",\n \"channels\": \"\"\n }\n ]\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-ea7d2112-1aa2-4767-a7de-79f54eae1507" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-854a8e33-17de-4d30-ae27-d3d133994b0e" } ], "id": "dc5c7463-d955-4af1-9ae2-24aa5ebf3073", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-dc5c7463-d955-4af1-9ae2-24aa5ebf3073" }, { "name": "playback-ids", "item": [ { "name": "{PLAYBACK_ID}", "item": [ { "name": "Retrieve a Playback ID", "id": "71589174-c532-4046-9858-9aeebd9ef0fb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/playback-ids/:PLAYBACK_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "playback-ids", ":PLAYBACK_ID" ], "variable": [ { "id": "b2de7cbc-bab6-44c7-8213-dbaab89af881", "key": "ASSET_ID", "value": "", "description": "(Required) The asset ID." }, { "id": "95d594c7-5964-4efe-b902-0b090e3b993b", "key": "PLAYBACK_ID", "value": "", "description": "(Required) The asset or live stream's playback ID." } ] }, "description": "Retrieves information about the specified playback ID." }, "response": [ { "id": "e368a20c-0f1c-46c0-ad64-0c164a98664a", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/playback-ids/:PLAYBACK_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "playback-ids", ":PLAYBACK_ID" ], "variable": [ { "key": "ASSET_ID" }, { "key": "PLAYBACK_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e368a20c-0f1c-46c0-ad64-0c164a98664a" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-71589174-c532-4046-9858-9aeebd9ef0fb" }, { "name": "Delete a Playback ID", "id": "74c2dc3d-af73-498b-922a-1fadfea2fb22", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/playback-ids/:PLAYBACK_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "playback-ids", ":PLAYBACK_ID" ], "variable": [ { "id": "a9efc25a-aa03-4ef2-93c4-6849c5d8fd3c", "key": "ASSET_ID", "value": "", "description": "(Required) The asset ID." }, { "id": "d6c5b03e-4ccc-4888-9abe-3a29f8ae57dc", "key": "PLAYBACK_ID", "value": "", "description": "(Required) The asset or live stream's playback ID." } ] }, "description": "Deletes a playback ID, rendering it nonfunctional for viewing an asset's video content. Please note that deleting the playback ID removes access to the underlying asset; a viewer who started playback before the playback ID was deleted may be able to watch the entire video for a limited duration." }, "response": [ { "id": "60546e8c-de9d-4f98-aa18-24caadd093b9", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/playback-ids/:PLAYBACK_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "playback-ids", ":PLAYBACK_ID" ], "variable": [ { "key": "ASSET_ID" }, { "key": "PLAYBACK_ID" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-60546e8c-de9d-4f98-aa18-24caadd093b9" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-74c2dc3d-af73-498b-922a-1fadfea2fb22" } ], "id": "23b47e9b-3698-492c-9317-f307c49b6023", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-23b47e9b-3698-492c-9317-f307c49b6023" }, { "name": "Create a Playback ID", "id": "0f69a2a1-7524-4057-9bb6-376d3721a1e9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/playback-ids", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "playback-ids" ], "variable": [ { "id": "1c8ff242-05d0-45e0-b1f4-75f8584055e8", "key": "ASSET_ID", "value": "", "description": "(Required) The asset ID." } ] }, "description": "Creates a playback ID that can be used to stream the asset to a viewer." }, "response": [ { "id": "ec64abc0-771e-412c-a527-fe0b3e815c6a", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/playback-ids", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "playback-ids" ], "variable": [ { "key": "ASSET_ID" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-ec64abc0-771e-412c-a527-fe0b3e815c6a" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-0f69a2a1-7524-4057-9bb6-376d3721a1e9" } ], "id": "9384c0e0-830c-43f5-aef1-ee05bf1a4216", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-9384c0e0-830c-43f5-aef1-ee05bf1a4216" }, { "name": "mp4-support", "item": [ { "name": "Update MP4 Support", "id": "b4c3f7c4-7ef5-43af-b664-6a0bf120b5fa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"mp4_support\": \"audio-only,capped-1080p\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/mp4-support", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "mp4-support" ], "variable": [ { "id": "91b4a857-6395-4425-9bef-1080fe6f1246", "key": "ASSET_ID", "value": "", "description": "(Required) The asset ID." } ] }, "description": "This method has been deprecated. Please see the [Static Rendition API](https://www.mux.com/docs/guides/enable-static-mp4-renditions#after-asset-creation).\nAllows you to add or remove mp4 support for assets that were created without it. The values supported are `capped-1080p`, `audio-only`, `audio-only,capped-1080p`, `standard`(deprecated), and `none`. `none` means that an asset *does not* have mp4 support, so submitting a request with `mp4_support` set to `none` will delete the mp4 assets from the asset in question.\n" }, "response": [ { "id": "4f8c2eb1-dbda-44d0-9efc-617175cad930", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"mp4_support\": \"audio-only,capped-1080p\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/mp4-support", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "mp4-support" ], "variable": [ { "key": "ASSET_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"status\": \"ready\",\n \"max_resolution_tier\": \"2160p\",\n \"encoding_tier\": \"smart\",\n \"master_access\": \"none\",\n \"progress\": {\n \"state\": \"transcoding\",\n \"progress\": \"\"\n },\n \"duration\": \"\",\n \"max_stored_resolution\": \"HD\",\n \"resolution_tier\": \"audio-only\",\n \"video_quality\": \"basic\",\n \"max_stored_frame_rate\": \"\",\n \"aspect_ratio\": \"\",\n \"playback_ids\": [\n {\n \"id\": \"\",\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"id\": \"\",\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"tracks\": [\n {\n \"id\": \"\",\n \"type\": \"text\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"generated_live\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"ready\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"text\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"embedded\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"ready\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n }\n ],\n \"errors\": {\n \"type\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ]\n },\n \"per_title_encode\": \"\",\n \"upload_id\": \"\",\n \"is_live\": \"\",\n \"passthrough\": \"\",\n \"live_stream_id\": \"\",\n \"master\": {\n \"status\": \"preparing\",\n \"url\": \"\"\n },\n \"mp4_support\": \"none\",\n \"source_asset_id\": \"\",\n \"normalize_audio\": false,\n \"static_renditions\": {\n \"status\": \"disabled\",\n \"files\": [\n {\n \"name\": \"low.mp4\",\n \"ext\": \"mp4\",\n \"height\": \"\",\n \"width\": \"\",\n \"bitrate\": \"\",\n \"filesize\": \"\",\n \"type\": \"advanced\",\n \"status\": \"errored\",\n \"resolution_tier\": \"2160p\",\n \"resolution\": \"360p\",\n \"id\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"name\": \"2160p.mp4\",\n \"ext\": \"m4a\",\n \"height\": \"\",\n \"width\": \"\",\n \"bitrate\": \"\",\n \"filesize\": \"\",\n \"type\": \"advanced\",\n \"status\": \"preparing\",\n \"resolution_tier\": \"1080p\",\n \"resolution\": \"1080p\",\n \"id\": \"\",\n \"passthrough\": \"\"\n }\n ]\n },\n \"recording_times\": [\n {\n \"started_at\": \"\",\n \"duration\": \"\",\n \"type\": \"slate\"\n },\n {\n \"started_at\": \"\",\n \"duration\": \"\",\n \"type\": \"slate\"\n }\n ],\n \"non_standard_input_reasons\": {\n \"video_codec\": \"\",\n \"audio_codec\": \"\",\n \"video_gop_size\": \"high\",\n \"video_frame_rate\": \"\",\n \"video_resolution\": \"\",\n \"video_bitrate\": \"high\",\n \"pixel_aspect_ratio\": \"\",\n \"video_edit_list\": \"non-standard\",\n \"audio_edit_list\": \"non-standard\",\n \"unexpected_media_file_parameters\": \"non-standard\",\n \"unsupported_pixel_format\": \"\"\n },\n \"test\": \"\",\n \"ingest_type\": \"on_demand_clip\",\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-4f8c2eb1-dbda-44d0-9efc-617175cad930" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b4c3f7c4-7ef5-43af-b664-6a0bf120b5fa" } ], "id": "d0c867a6-de90-4fa4-ae68-03c2d831f57e", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-d0c867a6-de90-4fa4-ae68-03c2d831f57e" }, { "name": "master-access", "item": [ { "name": "Update Master Access", "id": "ff6f2a78-e34d-44a3-a305-15a4ab1e2860", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"master_access\": \"temporary\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/master-access", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "master-access" ], "variable": [ { "id": "d4cd91ab-d643-4a05-a41c-aafb280a5fac", "key": "ASSET_ID", "value": "", "description": "(Required) The asset ID." } ] }, "description": "Allows you to add temporary access to the master (highest-quality) version of the asset in MP4 format. A URL will be created that can be used to download the master version for 24 hours. After 24 hours Master Access will revert to \"none\".\nThis master version is not optimized for web and not meant to be streamed, only downloaded for purposes like archiving or editing the video offline." }, "response": [ { "id": "091c2458-6518-4412-a198-0d2505912f72", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"master_access\": \"temporary\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/master-access", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "master-access" ], "variable": [ { "key": "ASSET_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"status\": \"ready\",\n \"max_resolution_tier\": \"2160p\",\n \"encoding_tier\": \"smart\",\n \"master_access\": \"none\",\n \"progress\": {\n \"state\": \"transcoding\",\n \"progress\": \"\"\n },\n \"duration\": \"\",\n \"max_stored_resolution\": \"HD\",\n \"resolution_tier\": \"audio-only\",\n \"video_quality\": \"basic\",\n \"max_stored_frame_rate\": \"\",\n \"aspect_ratio\": \"\",\n \"playback_ids\": [\n {\n \"id\": \"\",\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"id\": \"\",\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"tracks\": [\n {\n \"id\": \"\",\n \"type\": \"text\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"generated_live\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"ready\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"text\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"embedded\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"ready\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n }\n ],\n \"errors\": {\n \"type\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ]\n },\n \"per_title_encode\": \"\",\n \"upload_id\": \"\",\n \"is_live\": \"\",\n \"passthrough\": \"\",\n \"live_stream_id\": \"\",\n \"master\": {\n \"status\": \"preparing\",\n \"url\": \"\"\n },\n \"mp4_support\": \"none\",\n \"source_asset_id\": \"\",\n \"normalize_audio\": false,\n \"static_renditions\": {\n \"status\": \"disabled\",\n \"files\": [\n {\n \"name\": \"low.mp4\",\n \"ext\": \"mp4\",\n \"height\": \"\",\n \"width\": \"\",\n \"bitrate\": \"\",\n \"filesize\": \"\",\n \"type\": \"advanced\",\n \"status\": \"errored\",\n \"resolution_tier\": \"2160p\",\n \"resolution\": \"360p\",\n \"id\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"name\": \"2160p.mp4\",\n \"ext\": \"m4a\",\n \"height\": \"\",\n \"width\": \"\",\n \"bitrate\": \"\",\n \"filesize\": \"\",\n \"type\": \"advanced\",\n \"status\": \"preparing\",\n \"resolution_tier\": \"1080p\",\n \"resolution\": \"1080p\",\n \"id\": \"\",\n \"passthrough\": \"\"\n }\n ]\n },\n \"recording_times\": [\n {\n \"started_at\": \"\",\n \"duration\": \"\",\n \"type\": \"slate\"\n },\n {\n \"started_at\": \"\",\n \"duration\": \"\",\n \"type\": \"slate\"\n }\n ],\n \"non_standard_input_reasons\": {\n \"video_codec\": \"\",\n \"audio_codec\": \"\",\n \"video_gop_size\": \"high\",\n \"video_frame_rate\": \"\",\n \"video_resolution\": \"\",\n \"video_bitrate\": \"high\",\n \"pixel_aspect_ratio\": \"\",\n \"video_edit_list\": \"non-standard\",\n \"audio_edit_list\": \"non-standard\",\n \"unexpected_media_file_parameters\": \"non-standard\",\n \"unsupported_pixel_format\": \"\"\n },\n \"test\": \"\",\n \"ingest_type\": \"on_demand_clip\",\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-091c2458-6518-4412-a198-0d2505912f72" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-ff6f2a78-e34d-44a3-a305-15a4ab1e2860" } ], "id": "600af977-78a1-40c1-84c9-c451fe8e5229", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-600af977-78a1-40c1-84c9-c451fe8e5229" }, { "name": "static-renditions", "item": [ { "name": "{STATIC_RENDITION_ID}", "item": [ { "name": "Delete a Single Static Rendition for an Asset", "id": "a96292b7-67ab-4806-9554-557529a1b7a6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/static-renditions/:STATIC_RENDITION_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "static-renditions", ":STATIC_RENDITION_ID" ], "variable": [ { "id": "77030162-0af3-42e2-aca3-206f6fe593a2", "key": "ASSET_ID", "value": "", "description": "(Required) The asset ID." }, { "id": "46d76e95-cbc9-4e52-a4ae-dd2281630e82", "key": "STATIC_RENDITION_ID", "value": "", "description": "(Required) The static rendition ID." } ] }, "description": "Deletes a single static rendition for an asset" }, "response": [ { "id": "b24e58a2-90f8-4dc2-b5d7-4524f8ef73cb", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/static-renditions/:STATIC_RENDITION_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "static-renditions", ":STATIC_RENDITION_ID" ], "variable": [ { "key": "ASSET_ID" }, { "key": "STATIC_RENDITION_ID" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b24e58a2-90f8-4dc2-b5d7-4524f8ef73cb" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a96292b7-67ab-4806-9554-557529a1b7a6" } ], "id": "7efe9aa7-e6f1-47c3-ae8e-f69ef58cd7bf", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-7efe9aa7-e6f1-47c3-ae8e-f69ef58cd7bf" }, { "name": "Create a Static Rendition for an Asset", "id": "67cfdc9c-5ffe-41c0-a5f0-b90f232f0965", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"resolution\": \"360p\",\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/static-renditions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "static-renditions" ], "variable": [ { "id": "cad6e9ab-1b7b-4397-91d1-8d9b797f026f", "key": "ASSET_ID", "value": "", "description": "(Required) The asset ID." } ] }, "description": "Creates a static rendition (i.e. MP4) for an asset" }, "response": [ { "id": "a800ba52-636d-4a49-960e-363ddf0e9a07", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"resolution\": \"360p\",\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/static-renditions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "static-renditions" ], "variable": [ { "key": "ASSET_ID" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"name\": \"1440p.mp4\",\n \"ext\": \"mp4\",\n \"height\": \"\",\n \"width\": \"\",\n \"bitrate\": \"\",\n \"filesize\": \"\",\n \"type\": \"standard\",\n \"status\": \"ready\",\n \"resolution_tier\": \"audio-only\",\n \"resolution\": \"270p\",\n \"id\": \"\",\n \"passthrough\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a800ba52-636d-4a49-960e-363ddf0e9a07" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-67cfdc9c-5ffe-41c0-a5f0-b90f232f0965" } ], "id": "cc66cff0-7ba2-4f6b-9b6f-d0d816ea8c31", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-cc66cff0-7ba2-4f6b-9b6f-d0d816ea8c31" }, { "name": "tracks", "item": [ { "name": "{TRACK_ID}", "item": [ { "name": "generate-subtitles", "item": [ { "name": "Generate Track Subtitles", "id": "64312916-f4a6-4887-bce8-210897896975", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/tracks/:TRACK_ID/generate-subtitles", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "tracks", ":TRACK_ID", "generate-subtitles" ], "variable": [ { "id": "c6e94509-ee8f-4ac1-bf36-8dd405f5db51", "key": "ASSET_ID", "value": "", "description": "(Required) The asset ID." }, { "id": "efb45840-9a93-42fc-ac5a-509f070c4be3", "key": "TRACK_ID", "value": "", "description": "(Required) The ID of the track for an asset." } ] }, "description": "Generates subtitles (captions) for a given audio track. [See docs for more information.](https://mux.com/docs/guides/add-autogenerated-captions-and-use-transcripts#retroactively-enable-auto-generated-captions)" }, "response": [ { "id": "867251ee-8f08-41cd-ae31-7dbab253c44d", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/tracks/:TRACK_ID/generate-subtitles", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "tracks", ":TRACK_ID", "generate-subtitles" ], "variable": [ { "key": "ASSET_ID" }, { "key": "TRACK_ID" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"video\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"uploaded\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"errored\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"text\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"generated_live\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"preparing\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-867251ee-8f08-41cd-ae31-7dbab253c44d" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-64312916-f4a6-4887-bce8-210897896975" } ], "id": "0e785bde-0cf6-4d37-a5b1-6769367db864", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-0e785bde-0cf6-4d37-a5b1-6769367db864" }, { "name": "Delete an Asset Track", "id": "60b246ea-97c0-4024-960c-d710858916df", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/tracks/:TRACK_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "tracks", ":TRACK_ID" ], "variable": [ { "id": "3e33bbdd-f81e-4856-85bd-d43242e33eea", "key": "ASSET_ID", "value": "", "description": "(Required) The asset ID." }, { "id": "779a8202-6f9c-48e7-850c-371d57af2fa5", "key": "TRACK_ID", "value": "", "description": "(Required) The ID of the track for an asset." } ] }, "description": "Removes a text or additional audio track from an asset. Neither video nor the primary audio track can be removed." }, "response": [ { "id": "9fa03aba-0924-4403-8404-e9960ffd61db", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/tracks/:TRACK_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "tracks", ":TRACK_ID" ], "variable": [ { "key": "ASSET_ID" }, { "key": "TRACK_ID" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-9fa03aba-0924-4403-8404-e9960ffd61db" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-60b246ea-97c0-4024-960c-d710858916df" }, { "name": "Update an Asset Track", "id": "e9591a52-0723-4da3-87ff-ba96ced26ce5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/tracks/:TRACK_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "tracks", ":TRACK_ID" ], "variable": [ { "id": "9127d0a2-acfe-48c8-a00a-61faa7584209", "key": "ASSET_ID", "value": "", "description": "(Required) The asset ID." }, { "id": "f8bbd4c7-dd88-41e3-8aed-fdbbd9a8f708", "key": "TRACK_ID", "value": "", "description": "(Required) The ID of the track for an asset." } ] }, "description": "Updates the details of an existing Asset Track with the provided Asset ID and Track ID." }, "response": [ { "id": "6949aaf7-5d32-47d5-8b5b-c9f8be8d913f", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/tracks/:TRACK_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "tracks", ":TRACK_ID" ], "variable": [ { "key": "ASSET_ID" }, { "key": "TRACK_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"video\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"generated_live_final\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"errored\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-6949aaf7-5d32-47d5-8b5b-c9f8be8d913f" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e9591a52-0723-4da3-87ff-ba96ced26ce5" } ], "id": "77aa9c27-1bb2-4951-bf43-9bc0d7dfdb99", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-77aa9c27-1bb2-4951-bf43-9bc0d7dfdb99" }, { "name": "Create an Asset Track", "id": "aebd5bde-ad01-4a24-8dd9-efa40a376bbb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"type\": \"text\",\n \"language_code\": \"\",\n \"text_type\": \"subtitles\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/tracks", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "tracks" ], "variable": [ { "id": "ffb7acc9-74b7-4777-8191-41c53104a487", "key": "ASSET_ID", "value": "", "description": "(Required) The asset ID." } ] }, "description": "Adds an asset track (for example, subtitles, or an alternate audio track) to an asset. Assets must be in the `ready` state before tracks can be added." }, "response": [ { "id": "6eaf3a9d-34bb-4100-b960-27e0a5b62ff9", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"type\": \"text\",\n \"language_code\": \"\",\n \"text_type\": \"subtitles\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID/tracks", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID", "tracks" ], "variable": [ { "key": "ASSET_ID" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"video\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"generated_live_final\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"errored\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-6eaf3a9d-34bb-4100-b960-27e0a5b62ff9" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-aebd5bde-ad01-4a24-8dd9-efa40a376bbb" } ], "id": "b72cc327-b84c-4cc0-9e83-095d97b77453", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b72cc327-b84c-4cc0-9e83-095d97b77453" }, { "name": "Retrieve an Asset", "id": "3d9bd60b-2a14-426a-81a5-367fb5482294", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID" ], "variable": [ { "id": "1f2d1bf0-a35b-43c6-bd98-2ecbe4a3db26", "key": "ASSET_ID", "value": "", "description": "(Required) The asset ID." } ] }, "description": "Retrieves the details of an asset that has previously been created. Supply the unique asset ID that was returned from your previous request, and Mux will return the corresponding asset information. The same information is returned when creating an asset." }, "response": [ { "id": "f0b9641e-b1a7-4ae2-8277-3862284ae45a", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID" ], "variable": [ { "key": "ASSET_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"status\": \"ready\",\n \"max_resolution_tier\": \"2160p\",\n \"encoding_tier\": \"smart\",\n \"master_access\": \"none\",\n \"progress\": {\n \"state\": \"transcoding\",\n \"progress\": \"\"\n },\n \"duration\": \"\",\n \"max_stored_resolution\": \"HD\",\n \"resolution_tier\": \"audio-only\",\n \"video_quality\": \"basic\",\n \"max_stored_frame_rate\": \"\",\n \"aspect_ratio\": \"\",\n \"playback_ids\": [\n {\n \"id\": \"\",\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"id\": \"\",\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"tracks\": [\n {\n \"id\": \"\",\n \"type\": \"text\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"generated_live\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"ready\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"text\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"embedded\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"ready\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n }\n ],\n \"errors\": {\n \"type\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ]\n },\n \"per_title_encode\": \"\",\n \"upload_id\": \"\",\n \"is_live\": \"\",\n \"passthrough\": \"\",\n \"live_stream_id\": \"\",\n \"master\": {\n \"status\": \"preparing\",\n \"url\": \"\"\n },\n \"mp4_support\": \"none\",\n \"source_asset_id\": \"\",\n \"normalize_audio\": false,\n \"static_renditions\": {\n \"status\": \"disabled\",\n \"files\": [\n {\n \"name\": \"low.mp4\",\n \"ext\": \"mp4\",\n \"height\": \"\",\n \"width\": \"\",\n \"bitrate\": \"\",\n \"filesize\": \"\",\n \"type\": \"advanced\",\n \"status\": \"errored\",\n \"resolution_tier\": \"2160p\",\n \"resolution\": \"360p\",\n \"id\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"name\": \"2160p.mp4\",\n \"ext\": \"m4a\",\n \"height\": \"\",\n \"width\": \"\",\n \"bitrate\": \"\",\n \"filesize\": \"\",\n \"type\": \"advanced\",\n \"status\": \"preparing\",\n \"resolution_tier\": \"1080p\",\n \"resolution\": \"1080p\",\n \"id\": \"\",\n \"passthrough\": \"\"\n }\n ]\n },\n \"recording_times\": [\n {\n \"started_at\": \"\",\n \"duration\": \"\",\n \"type\": \"slate\"\n },\n {\n \"started_at\": \"\",\n \"duration\": \"\",\n \"type\": \"slate\"\n }\n ],\n \"non_standard_input_reasons\": {\n \"video_codec\": \"\",\n \"audio_codec\": \"\",\n \"video_gop_size\": \"high\",\n \"video_frame_rate\": \"\",\n \"video_resolution\": \"\",\n \"video_bitrate\": \"high\",\n \"pixel_aspect_ratio\": \"\",\n \"video_edit_list\": \"non-standard\",\n \"audio_edit_list\": \"non-standard\",\n \"unexpected_media_file_parameters\": \"non-standard\",\n \"unsupported_pixel_format\": \"\"\n },\n \"test\": \"\",\n \"ingest_type\": \"on_demand_clip\",\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f0b9641e-b1a7-4ae2-8277-3862284ae45a" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-3d9bd60b-2a14-426a-81a5-367fb5482294" }, { "name": "Delete an Asset", "id": "426a2155-3bae-473c-996b-ac32d55ca8ab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID" ], "variable": [ { "id": "0218ffe9-0f01-46f7-88a2-dddcddd64e6f", "key": "ASSET_ID", "value": "", "description": "(Required) The asset ID." } ] }, "description": "Deletes a video asset and all its data." }, "response": [ { "id": "d9f0a5a2-7dcb-4bb5-aef3-1fc61b633412", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID" ], "variable": [ { "key": "ASSET_ID" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-d9f0a5a2-7dcb-4bb5-aef3-1fc61b633412" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-426a2155-3bae-473c-996b-ac32d55ca8ab" }, { "name": "Update an Asset", "id": "0bf97483-2524-43ad-ac16-00a304175da3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"passthrough\": \"\",\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID" ], "variable": [ { "id": "ecb31700-2d60-4aac-bdca-d6b4f137342b", "key": "ASSET_ID", "value": "", "description": "(Required) The asset ID." } ] }, "description": "Updates the details of an existing Asset with the provided Asset ID. This API currently only supports the `passthrough` and `meta` fields." }, "response": [ { "id": "7d2bdbf4-d0c1-493e-b4b9-ba768b643d91", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"passthrough\": \"\",\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets/:ASSET_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets", ":ASSET_ID" ], "variable": [ { "key": "ASSET_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"status\": \"ready\",\n \"max_resolution_tier\": \"2160p\",\n \"encoding_tier\": \"smart\",\n \"master_access\": \"none\",\n \"progress\": {\n \"state\": \"transcoding\",\n \"progress\": \"\"\n },\n \"duration\": \"\",\n \"max_stored_resolution\": \"HD\",\n \"resolution_tier\": \"audio-only\",\n \"video_quality\": \"basic\",\n \"max_stored_frame_rate\": \"\",\n \"aspect_ratio\": \"\",\n \"playback_ids\": [\n {\n \"id\": \"\",\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"id\": \"\",\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"tracks\": [\n {\n \"id\": \"\",\n \"type\": \"text\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"generated_live\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"ready\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"text\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"embedded\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"ready\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n }\n ],\n \"errors\": {\n \"type\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ]\n },\n \"per_title_encode\": \"\",\n \"upload_id\": \"\",\n \"is_live\": \"\",\n \"passthrough\": \"\",\n \"live_stream_id\": \"\",\n \"master\": {\n \"status\": \"preparing\",\n \"url\": \"\"\n },\n \"mp4_support\": \"none\",\n \"source_asset_id\": \"\",\n \"normalize_audio\": false,\n \"static_renditions\": {\n \"status\": \"disabled\",\n \"files\": [\n {\n \"name\": \"low.mp4\",\n \"ext\": \"mp4\",\n \"height\": \"\",\n \"width\": \"\",\n \"bitrate\": \"\",\n \"filesize\": \"\",\n \"type\": \"advanced\",\n \"status\": \"errored\",\n \"resolution_tier\": \"2160p\",\n \"resolution\": \"360p\",\n \"id\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"name\": \"2160p.mp4\",\n \"ext\": \"m4a\",\n \"height\": \"\",\n \"width\": \"\",\n \"bitrate\": \"\",\n \"filesize\": \"\",\n \"type\": \"advanced\",\n \"status\": \"preparing\",\n \"resolution_tier\": \"1080p\",\n \"resolution\": \"1080p\",\n \"id\": \"\",\n \"passthrough\": \"\"\n }\n ]\n },\n \"recording_times\": [\n {\n \"started_at\": \"\",\n \"duration\": \"\",\n \"type\": \"slate\"\n },\n {\n \"started_at\": \"\",\n \"duration\": \"\",\n \"type\": \"slate\"\n }\n ],\n \"non_standard_input_reasons\": {\n \"video_codec\": \"\",\n \"audio_codec\": \"\",\n \"video_gop_size\": \"high\",\n \"video_frame_rate\": \"\",\n \"video_resolution\": \"\",\n \"video_bitrate\": \"high\",\n \"pixel_aspect_ratio\": \"\",\n \"video_edit_list\": \"non-standard\",\n \"audio_edit_list\": \"non-standard\",\n \"unexpected_media_file_parameters\": \"non-standard\",\n \"unsupported_pixel_format\": \"\"\n },\n \"test\": \"\",\n \"ingest_type\": \"on_demand_clip\",\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-7d2bdbf4-d0c1-493e-b4b9-ba768b643d91" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-0bf97483-2524-43ad-ac16-00a304175da3" } ], "id": "d3bedd90-8d08-4ea0-95ee-97b9fae71468", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-d3bedd90-8d08-4ea0-95ee-97b9fae71468" }, { "name": "Create an Asset", "id": "97bad81c-d724-4496-963e-08dc36d38ec7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"audio\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"drm\",\n \"drm\"\n ],\n \"playback_policies\": [\n \"signed\",\n \"signed\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"audio-only,capped-1080p\",\n \"normalize_audio\": false,\n \"master_access\": \"temporary\",\n \"test\": \"\",\n \"max_resolution_tier\": \"2160p\",\n \"encoding_tier\": \"baseline\",\n \"video_quality\": \"plus\",\n \"static_renditions\": [\n {\n \"resolution\": \"480p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"1080p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets" ] }, "description": "Create a new Mux Video asset." }, "response": [ { "id": "4efeaab1-11f1-4257-9894-c76fc5e806b9", "name": "Asset Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"audio\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"drm\",\n \"drm\"\n ],\n \"playback_policies\": [\n \"signed\",\n \"signed\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"audio-only,capped-1080p\",\n \"normalize_audio\": false,\n \"master_access\": \"temporary\",\n \"test\": \"\",\n \"max_resolution_tier\": \"2160p\",\n \"encoding_tier\": \"baseline\",\n \"video_quality\": \"plus\",\n \"static_renditions\": [\n {\n \"resolution\": \"480p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"1080p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/assets", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"status\": \"ready\",\n \"max_resolution_tier\": \"2160p\",\n \"encoding_tier\": \"smart\",\n \"master_access\": \"none\",\n \"progress\": {\n \"state\": \"transcoding\",\n \"progress\": \"\"\n },\n \"duration\": \"\",\n \"max_stored_resolution\": \"HD\",\n \"resolution_tier\": \"audio-only\",\n \"video_quality\": \"basic\",\n \"max_stored_frame_rate\": \"\",\n \"aspect_ratio\": \"\",\n \"playback_ids\": [\n {\n \"id\": \"\",\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"id\": \"\",\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"tracks\": [\n {\n \"id\": \"\",\n \"type\": \"text\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"generated_live\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"ready\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"text\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"embedded\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"ready\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n }\n ],\n \"errors\": {\n \"type\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ]\n },\n \"per_title_encode\": \"\",\n \"upload_id\": \"\",\n \"is_live\": \"\",\n \"passthrough\": \"\",\n \"live_stream_id\": \"\",\n \"master\": {\n \"status\": \"preparing\",\n \"url\": \"\"\n },\n \"mp4_support\": \"none\",\n \"source_asset_id\": \"\",\n \"normalize_audio\": false,\n \"static_renditions\": {\n \"status\": \"disabled\",\n \"files\": [\n {\n \"name\": \"low.mp4\",\n \"ext\": \"mp4\",\n \"height\": \"\",\n \"width\": \"\",\n \"bitrate\": \"\",\n \"filesize\": \"\",\n \"type\": \"advanced\",\n \"status\": \"errored\",\n \"resolution_tier\": \"2160p\",\n \"resolution\": \"360p\",\n \"id\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"name\": \"2160p.mp4\",\n \"ext\": \"m4a\",\n \"height\": \"\",\n \"width\": \"\",\n \"bitrate\": \"\",\n \"filesize\": \"\",\n \"type\": \"advanced\",\n \"status\": \"preparing\",\n \"resolution_tier\": \"1080p\",\n \"resolution\": \"1080p\",\n \"id\": \"\",\n \"passthrough\": \"\"\n }\n ]\n },\n \"recording_times\": [\n {\n \"started_at\": \"\",\n \"duration\": \"\",\n \"type\": \"slate\"\n },\n {\n \"started_at\": \"\",\n \"duration\": \"\",\n \"type\": \"slate\"\n }\n ],\n \"non_standard_input_reasons\": {\n \"video_codec\": \"\",\n \"audio_codec\": \"\",\n \"video_gop_size\": \"high\",\n \"video_frame_rate\": \"\",\n \"video_resolution\": \"\",\n \"video_bitrate\": \"high\",\n \"pixel_aspect_ratio\": \"\",\n \"video_edit_list\": \"non-standard\",\n \"audio_edit_list\": \"non-standard\",\n \"unexpected_media_file_parameters\": \"non-standard\",\n \"unsupported_pixel_format\": \"\"\n },\n \"test\": \"\",\n \"ingest_type\": \"on_demand_clip\",\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-4efeaab1-11f1-4257-9894-c76fc5e806b9" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-97bad81c-d724-4496-963e-08dc36d38ec7" }, { "name": "List Assets", "id": "77b343f6-3743-4589-bdee-2719c1dda21d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/assets?limit=25&page=1&cursor=&live_stream_id=&upload_id=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "This parameter is used to request pages beyond the first. You can find the cursor value in the `next_cursor` field of paginated responses.", "key": "cursor", "value": "" }, { "description": "Filter response to return all the assets for this live stream only", "key": "live_stream_id", "value": "" }, { "description": "Filter response to return an asset created from this direct upload only", "key": "upload_id", "value": "" } ] }, "description": "List all Mux assets." }, "response": [ { "id": "87a3f30f-4e5d-40e6-b02b-1ef2bd751015", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/assets?limit=25&page=1&cursor=&live_stream_id=&upload_id=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "assets" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "This parameter is used to request pages beyond the first. You can find the cursor value in the `next_cursor` field of paginated responses.", "key": "cursor", "value": "" }, { "description": "Filter response to return all the assets for this live stream only", "key": "live_stream_id", "value": "" }, { "description": "Filter response to return an asset created from this direct upload only", "key": "upload_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"status\": \"preparing\",\n \"max_resolution_tier\": \"2160p\",\n \"encoding_tier\": \"baseline\",\n \"master_access\": \"none\",\n \"progress\": {\n \"state\": \"completed\",\n \"progress\": \"\"\n },\n \"duration\": \"\",\n \"max_stored_resolution\": \"HD\",\n \"resolution_tier\": \"audio-only\",\n \"video_quality\": \"basic\",\n \"max_stored_frame_rate\": \"\",\n \"aspect_ratio\": \"\",\n \"playback_ids\": [\n {\n \"id\": \"\",\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"id\": \"\",\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"tracks\": [\n {\n \"id\": \"\",\n \"type\": \"text\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"generated_vod\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"preparing\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"audio\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"uploaded\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"deleted\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n }\n ],\n \"errors\": {\n \"type\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ]\n },\n \"per_title_encode\": \"\",\n \"upload_id\": \"\",\n \"is_live\": \"\",\n \"passthrough\": \"\",\n \"live_stream_id\": \"\",\n \"master\": {\n \"status\": \"preparing\",\n \"url\": \"\"\n },\n \"mp4_support\": \"none\",\n \"source_asset_id\": \"\",\n \"normalize_audio\": false,\n \"static_renditions\": {\n \"status\": \"disabled\",\n \"files\": [\n {\n \"name\": \"2160p.mp4\",\n \"ext\": \"m4a\",\n \"height\": \"\",\n \"width\": \"\",\n \"bitrate\": \"\",\n \"filesize\": \"\",\n \"type\": \"advanced\",\n \"status\": \"ready\",\n \"resolution_tier\": \"2160p\",\n \"resolution\": \"1440p\",\n \"id\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"name\": \"270p.mp4\",\n \"ext\": \"mp4\",\n \"height\": \"\",\n \"width\": \"\",\n \"bitrate\": \"\",\n \"filesize\": \"\",\n \"type\": \"standard\",\n \"status\": \"skipped\",\n \"resolution_tier\": \"audio-only\",\n \"resolution\": \"270p\",\n \"id\": \"\",\n \"passthrough\": \"\"\n }\n ]\n },\n \"recording_times\": [\n {\n \"started_at\": \"\",\n \"duration\": \"\",\n \"type\": \"slate\"\n },\n {\n \"started_at\": \"\",\n \"duration\": \"\",\n \"type\": \"slate\"\n }\n ],\n \"non_standard_input_reasons\": {\n \"video_codec\": \"\",\n \"audio_codec\": \"\",\n \"video_gop_size\": \"high\",\n \"video_frame_rate\": \"\",\n \"video_resolution\": \"\",\n \"video_bitrate\": \"high\",\n \"pixel_aspect_ratio\": \"\",\n \"video_edit_list\": \"non-standard\",\n \"audio_edit_list\": \"non-standard\",\n \"unexpected_media_file_parameters\": \"non-standard\",\n \"unsupported_pixel_format\": \"\"\n },\n \"test\": \"\",\n \"ingest_type\": \"on_demand_clip\",\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"status\": \"ready\",\n \"max_resolution_tier\": \"2160p\",\n \"encoding_tier\": \"premium\",\n \"master_access\": \"none\",\n \"progress\": {\n \"state\": \"live\",\n \"progress\": \"\"\n },\n \"duration\": \"\",\n \"max_stored_resolution\": \"UHD\",\n \"resolution_tier\": \"720p\",\n \"video_quality\": \"plus\",\n \"max_stored_frame_rate\": \"\",\n \"aspect_ratio\": \"\",\n \"playback_ids\": [\n {\n \"id\": \"\",\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"id\": \"\",\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"tracks\": [\n {\n \"id\": \"\",\n \"type\": \"audio\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"generated_live\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"deleted\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"text\",\n \"duration\": \"\",\n \"max_width\": \"\",\n \"max_height\": \"\",\n \"max_frame_rate\": \"\",\n \"max_channels\": \"\",\n \"max_channel_layout\": \"\",\n \"text_type\": \"subtitles\",\n \"text_source\": \"embedded\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\",\n \"status\": \"deleted\",\n \"primary\": \"\",\n \"auto_language_confidence\": \"\"\n }\n ],\n \"errors\": {\n \"type\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ]\n },\n \"per_title_encode\": \"\",\n \"upload_id\": \"\",\n \"is_live\": \"\",\n \"passthrough\": \"\",\n \"live_stream_id\": \"\",\n \"master\": {\n \"status\": \"errored\",\n \"url\": \"\"\n },\n \"mp4_support\": \"none\",\n \"source_asset_id\": \"\",\n \"normalize_audio\": false,\n \"static_renditions\": {\n \"status\": \"disabled\",\n \"files\": [\n {\n \"name\": \"2160p.mp4\",\n \"ext\": \"m4a\",\n \"height\": \"\",\n \"width\": \"\",\n \"bitrate\": \"\",\n \"filesize\": \"\",\n \"type\": \"standard\",\n \"status\": \"preparing\",\n \"resolution_tier\": \"720p\",\n \"resolution\": \"audio-only\",\n \"id\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"name\": \"1440p.mp4\",\n \"ext\": \"mp4\",\n \"height\": \"\",\n \"width\": \"\",\n \"bitrate\": \"\",\n \"filesize\": \"\",\n \"type\": \"advanced\",\n \"status\": \"errored\",\n \"resolution_tier\": \"720p\",\n \"resolution\": \"audio-only\",\n \"id\": \"\",\n \"passthrough\": \"\"\n }\n ]\n },\n \"recording_times\": [\n {\n \"started_at\": \"\",\n \"duration\": \"\",\n \"type\": \"content\"\n },\n {\n \"started_at\": \"\",\n \"duration\": \"\",\n \"type\": \"slate\"\n }\n ],\n \"non_standard_input_reasons\": {\n \"video_codec\": \"\",\n \"audio_codec\": \"\",\n \"video_gop_size\": \"high\",\n \"video_frame_rate\": \"\",\n \"video_resolution\": \"\",\n \"video_bitrate\": \"high\",\n \"pixel_aspect_ratio\": \"\",\n \"video_edit_list\": \"non-standard\",\n \"audio_edit_list\": \"non-standard\",\n \"unexpected_media_file_parameters\": \"non-standard\",\n \"unsupported_pixel_format\": \"\"\n },\n \"test\": \"\",\n \"ingest_type\": \"on_demand_url\",\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n }\n }\n ],\n \"next_cursor\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-87a3f30f-4e5d-40e6-b02b-1ef2bd751015" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-77b343f6-3743-4589-bdee-2719c1dda21d" } ], "id": "34de4a63-455f-4361-a221-0e72169ee781", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-34de4a63-455f-4361-a221-0e72169ee781" }, { "name": "live-streams", "item": [ { "name": "{LIVE_STREAM_ID}", "item": [ { "name": "playback-ids", "item": [ { "name": "{PLAYBACK_ID}", "item": [ { "name": "Retrieve a Live Stream Playback ID", "id": "5f8633bd-2d53-45be-8be4-32dbf2fec09c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/playback-ids/:PLAYBACK_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "playback-ids", ":PLAYBACK_ID" ], "variable": [ { "id": "648a6296-9efc-4f48-9b7b-3cbd7a122446", "key": "LIVE_STREAM_ID", "value": "", "description": "(Required) The live stream ID" }, { "id": "5ac469cd-f179-4f83-9fbc-916ca72ad5b4", "key": "PLAYBACK_ID", "value": "", "description": "(Required) The asset or live stream's playback ID." } ] }, "description": "Fetches information about a live stream's playback ID, through which a viewer can watch the streamed content from this live stream." }, "response": [ { "id": "b9efdf76-61fd-4357-abc3-38460d8cbe7c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/playback-ids/:PLAYBACK_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "playback-ids", ":PLAYBACK_ID" ], "variable": [ { "key": "LIVE_STREAM_ID" }, { "key": "PLAYBACK_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b9efdf76-61fd-4357-abc3-38460d8cbe7c" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-5f8633bd-2d53-45be-8be4-32dbf2fec09c" }, { "name": "Delete a Live Stream Playback ID", "id": "39f13a39-1a74-4968-86aa-1629f979b40a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/playback-ids/:PLAYBACK_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "playback-ids", ":PLAYBACK_ID" ], "variable": [ { "id": "ec8fe722-b47d-47c8-965f-7f6e9c64254e", "key": "LIVE_STREAM_ID", "value": "", "description": "(Required) The live stream ID" }, { "id": "26093765-999a-4340-b549-1f9b42d057bb", "key": "PLAYBACK_ID", "value": "", "description": "(Required) The asset or live stream's playback ID." } ] }, "description": "Deletes the playback ID for the live stream. This will not disable ingest (as the live stream still exists). New attempts to play back the live stream will fail immediately. However, current viewers will be able to continue watching the stream for some period of time." }, "response": [ { "id": "26456458-8909-4439-a414-65f34a43547e", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/playback-ids/:PLAYBACK_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "playback-ids", ":PLAYBACK_ID" ], "variable": [ { "key": "LIVE_STREAM_ID" }, { "key": "PLAYBACK_ID" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-26456458-8909-4439-a414-65f34a43547e" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-39f13a39-1a74-4968-86aa-1629f979b40a" } ], "id": "4b39a2f0-05ba-4fc2-b1b8-c2675b2db284", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-4b39a2f0-05ba-4fc2-b1b8-c2675b2db284" }, { "name": "Create a Live Stream Playback ID", "id": "2d787fbe-223f-41cb-8538-d4ca5d4cf255", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/playback-ids", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "playback-ids" ], "variable": [ { "id": "53d20297-02b3-47c8-85e1-d1e0b222e026", "key": "LIVE_STREAM_ID", "value": "", "description": "(Required) The live stream ID" } ] }, "description": "Create a new playback ID for this live stream, through which a viewer can watch the streamed content of the live stream." }, "response": [ { "id": "bc7e7071-fcea-4360-aec8-e592cb11fdbc", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/playback-ids", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "playback-ids" ], "variable": [ { "key": "LIVE_STREAM_ID" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-bc7e7071-fcea-4360-aec8-e592cb11fdbc" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-2d787fbe-223f-41cb-8538-d4ca5d4cf255" } ], "id": "b1327e6c-0e7b-43ed-b598-6e0df4d79bab", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b1327e6c-0e7b-43ed-b598-6e0df4d79bab" }, { "name": "reset-stream-key", "item": [ { "name": "Reset a Live Stream's Stream Key", "id": "399f3864-58e9-4e39-8599-3c2031dbd6f3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/reset-stream-key", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "reset-stream-key" ], "variable": [ { "id": "3f7e35f2-bc21-4602-a6bf-dc409db85b2f", "key": "LIVE_STREAM_ID", "value": "", "description": "(Required) The live stream ID" } ] }, "description": "Reset a live stream key if you want to immediately stop the current stream key from working and create a new stream key that can be used for future broadcasts." }, "response": [ { "id": "34ee0c66-6f3d-42e4-ab68-20764b7803be", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/reset-stream-key", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "reset-stream-key" ], "variable": [ { "key": "LIVE_STREAM_ID" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"latency_mode\": \"standard\",\n \"max_continuous_duration\": 43200,\n \"status\": \"active\",\n \"stream_key\": \"\",\n \"active_asset_id\": \"\",\n \"recent_asset_ids\": [\n \"\",\n \"\"\n ],\n \"playback_ids\": [\n {\n \"id\": \"\",\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"id\": \"\",\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"public\",\n \"drm\"\n ],\n \"playback_policies\": [\n \"drm\",\n \"signed\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"capped-1080p\",\n \"normalize_audio\": false,\n \"master_access\": \"none\",\n \"test\": \"\",\n \"max_resolution_tier\": \"1440p\",\n \"encoding_tier\": \"premium\",\n \"video_quality\": \"premium\",\n \"static_renditions\": [\n {\n \"resolution\": \"2160p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"360p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"passthrough\": \"\",\n \"audio_only\": \"\",\n \"embedded_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n }\n ],\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"reconnect_window\": 60,\n \"use_slate_for_standard_latency\": false,\n \"reconnect_slate_url\": \"\",\n \"reduced_latency\": \"\",\n \"low_latency\": \"\",\n \"simulcast_targets\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"broadcasting\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"normal\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"starting\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"normal\"\n }\n ],\n \"test\": \"\",\n \"srt_passphrase\": \"\",\n \"active_ingest_protocol\": \"rtmp\",\n \"meta\": {\n \"title\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-34ee0c66-6f3d-42e4-ab68-20764b7803be" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-399f3864-58e9-4e39-8599-3c2031dbd6f3" } ], "id": "b6e246fd-e497-4d8b-b638-84d87f78b036", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b6e246fd-e497-4d8b-b638-84d87f78b036" }, { "name": "complete", "item": [ { "name": "Signal a Live Stream Is Finished", "id": "730b9bc0-2916-42f9-baaf-f4e224d37367", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/complete", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "complete" ], "variable": [ { "id": "64386e7e-7daa-4b84-a81d-f59dc0ea6652", "key": "LIVE_STREAM_ID", "value": "", "description": "(Required) The live stream ID" } ] }, "description": "(Optional) End the live stream recording immediately instead of waiting for the reconnect_window. `EXT-X-ENDLIST` tag is added to the HLS manifest which notifies the player that this live stream is over.\n\nMux does not close the encoder connection immediately. Encoders are often configured to re-establish connections immediately which would result in a new recorded asset. For this reason, Mux waits for 60s before closing the connection with the encoder. This 60s timeframe is meant to give encoder operators a chance to disconnect from their end.\n" }, "response": [ { "id": "fed83caf-ca02-4c7d-acaf-93b7c7533a05", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/complete", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "complete" ], "variable": [ { "key": "LIVE_STREAM_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-fed83caf-ca02-4c7d-acaf-93b7c7533a05" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-730b9bc0-2916-42f9-baaf-f4e224d37367" } ], "id": "2b162765-2727-4839-b32b-94f5a2a9456c", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-2b162765-2727-4839-b32b-94f5a2a9456c" }, { "name": "disable", "item": [ { "name": "Disable a Live Stream", "id": "aed70ebc-53dd-4cb5-9ae4-70a16b70c3d3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/disable", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "disable" ], "variable": [ { "id": "e2aaa796-fc38-41c3-8ef4-14cfa1b91ddc", "key": "LIVE_STREAM_ID", "value": "", "description": "(Required) The live stream ID" } ] }, "description": "Disables a live stream, making it reject incoming RTMP streams until re-enabled. The API also ends the live stream recording immediately when active. Ending the live stream recording adds the `EXT-X-ENDLIST` tag to the HLS manifest which notifies the player that this live stream is over.\n\nMux also closes the encoder connection immediately. Any attempt from the encoder to re-establish connection will fail till the live stream is re-enabled.\n" }, "response": [ { "id": "81b8b6ff-ee0e-4df8-b3fd-ed0a0d970108", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/disable", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "disable" ], "variable": [ { "key": "LIVE_STREAM_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-81b8b6ff-ee0e-4df8-b3fd-ed0a0d970108" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-aed70ebc-53dd-4cb5-9ae4-70a16b70c3d3" } ], "id": "1eeb6ec8-56ed-4474-9c40-b61fe7b0b24d", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-1eeb6ec8-56ed-4474-9c40-b61fe7b0b24d" }, { "name": "enable", "item": [ { "name": "Enable a Live Stream", "id": "31498e1d-7722-4706-9f74-37b4c0804fb0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/enable", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "enable" ], "variable": [ { "id": "ec3c2b37-34c8-4c50-8be4-bca25e0b24ac", "key": "LIVE_STREAM_ID", "value": "", "description": "(Required) The live stream ID" } ] }, "description": "Enables a live stream, allowing it to accept an incoming RTMP stream." }, "response": [ { "id": "34a9bc91-de8e-4c89-87ee-b64a6540df3b", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/enable", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "enable" ], "variable": [ { "key": "LIVE_STREAM_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-34a9bc91-de8e-4c89-87ee-b64a6540df3b" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-31498e1d-7722-4706-9f74-37b4c0804fb0" } ], "id": "159b449f-ae3f-4837-90e2-39b5d2785c9a", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-159b449f-ae3f-4837-90e2-39b5d2785c9a" }, { "name": "embedded-subtitles", "item": [ { "name": "Update a Live Stream's Embedded Subtitles", "id": "052db89c-3a46-44d0-b89b-dc49661e09ba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"embedded_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/embedded-subtitles", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "embedded-subtitles" ], "variable": [ { "id": "8ba8bf0f-80e8-439f-b712-4d2b34b30266", "key": "LIVE_STREAM_ID", "value": "", "description": "(Required) The live stream ID" } ] }, "description": "Configures a live stream to receive embedded closed captions.\nThe resulting Asset's subtitle text track will have `closed_captions: true` set.\n" }, "response": [ { "id": "4b54541c-d82f-44a7-8120-d3ab727e94ba", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"embedded_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/embedded-subtitles", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "embedded-subtitles" ], "variable": [ { "key": "LIVE_STREAM_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"latency_mode\": \"standard\",\n \"max_continuous_duration\": 43200,\n \"status\": \"active\",\n \"stream_key\": \"\",\n \"active_asset_id\": \"\",\n \"recent_asset_ids\": [\n \"\",\n \"\"\n ],\n \"playback_ids\": [\n {\n \"id\": \"\",\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"id\": \"\",\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"public\",\n \"drm\"\n ],\n \"playback_policies\": [\n \"drm\",\n \"signed\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"capped-1080p\",\n \"normalize_audio\": false,\n \"master_access\": \"none\",\n \"test\": \"\",\n \"max_resolution_tier\": \"1440p\",\n \"encoding_tier\": \"premium\",\n \"video_quality\": \"premium\",\n \"static_renditions\": [\n {\n \"resolution\": \"2160p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"360p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"passthrough\": \"\",\n \"audio_only\": \"\",\n \"embedded_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n }\n ],\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"reconnect_window\": 60,\n \"use_slate_for_standard_latency\": false,\n \"reconnect_slate_url\": \"\",\n \"reduced_latency\": \"\",\n \"low_latency\": \"\",\n \"simulcast_targets\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"broadcasting\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"normal\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"starting\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"normal\"\n }\n ],\n \"test\": \"\",\n \"srt_passphrase\": \"\",\n \"active_ingest_protocol\": \"rtmp\",\n \"meta\": {\n \"title\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-4b54541c-d82f-44a7-8120-d3ab727e94ba" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-052db89c-3a46-44d0-b89b-dc49661e09ba" } ], "id": "0ba96237-aae0-4bd0-8198-b53bdf4bbc54", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-0ba96237-aae0-4bd0-8198-b53bdf4bbc54" }, { "name": "generated-subtitles", "item": [ { "name": "Update a Live Stream's Generated Subtitles", "id": "0acc71bf-47a4-402a-8263-4e3fdb956add", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/generated-subtitles", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "generated-subtitles" ], "variable": [ { "id": "18b28ae4-8987-4a49-8f69-7bd8981c7c35", "key": "LIVE_STREAM_ID", "value": "", "description": "(Required) The live stream ID" } ] }, "description": "Updates a live stream's automatic-speech-recognition-generated subtitle configuration.\nAutomatic speech recognition subtitles can be removed by sending an empty array in the\nrequest payload.\n" }, "response": [ { "id": "e433814e-bd9e-4525-993d-53091b5edecf", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/generated-subtitles", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "generated-subtitles" ], "variable": [ { "key": "LIVE_STREAM_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"latency_mode\": \"standard\",\n \"max_continuous_duration\": 43200,\n \"status\": \"active\",\n \"stream_key\": \"\",\n \"active_asset_id\": \"\",\n \"recent_asset_ids\": [\n \"\",\n \"\"\n ],\n \"playback_ids\": [\n {\n \"id\": \"\",\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"id\": \"\",\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"public\",\n \"drm\"\n ],\n \"playback_policies\": [\n \"drm\",\n \"signed\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"capped-1080p\",\n \"normalize_audio\": false,\n \"master_access\": \"none\",\n \"test\": \"\",\n \"max_resolution_tier\": \"1440p\",\n \"encoding_tier\": \"premium\",\n \"video_quality\": \"premium\",\n \"static_renditions\": [\n {\n \"resolution\": \"2160p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"360p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"passthrough\": \"\",\n \"audio_only\": \"\",\n \"embedded_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n }\n ],\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"reconnect_window\": 60,\n \"use_slate_for_standard_latency\": false,\n \"reconnect_slate_url\": \"\",\n \"reduced_latency\": \"\",\n \"low_latency\": \"\",\n \"simulcast_targets\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"broadcasting\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"normal\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"starting\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"normal\"\n }\n ],\n \"test\": \"\",\n \"srt_passphrase\": \"\",\n \"active_ingest_protocol\": \"rtmp\",\n \"meta\": {\n \"title\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e433814e-bd9e-4525-993d-53091b5edecf" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-0acc71bf-47a4-402a-8263-4e3fdb956add" } ], "id": "5876d7ef-076e-4ff1-a1b8-6291125f1930", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-5876d7ef-076e-4ff1-a1b8-6291125f1930" }, { "name": "simulcast-targets", "item": [ { "name": "{SIMULCAST_TARGET_ID}", "item": [ { "name": "Delete a Live Stream Simulcast Target", "id": "0643dd6c-ae51-4fd6-a0cb-9e8a32fed22d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/simulcast-targets/:SIMULCAST_TARGET_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "simulcast-targets", ":SIMULCAST_TARGET_ID" ], "variable": [ { "id": "c664f71e-67db-4e80-8a31-1b125d4af8a7", "key": "LIVE_STREAM_ID", "value": "", "description": "(Required) The live stream ID" }, { "id": "a8898fac-89eb-4e83-9c1d-9ffc19046e8b", "key": "SIMULCAST_TARGET_ID", "value": "", "description": "(Required) The ID of the simulcast target." } ] }, "description": "Delete the simulcast target using the simulcast target ID returned when creating the simulcast target. Simulcast Target can only be deleted when the parent live stream is in idle state." }, "response": [ { "id": "4ccf8909-d66d-475c-98a6-eef54e32b61c", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/simulcast-targets/:SIMULCAST_TARGET_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "simulcast-targets", ":SIMULCAST_TARGET_ID" ], "variable": [ { "key": "LIVE_STREAM_ID" }, { "key": "SIMULCAST_TARGET_ID" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-4ccf8909-d66d-475c-98a6-eef54e32b61c" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-0643dd6c-ae51-4fd6-a0cb-9e8a32fed22d" }, { "name": "Retrieve a Live Stream Simulcast Target", "id": "55291881-5b88-4bb3-966c-327db780c2f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/simulcast-targets/:SIMULCAST_TARGET_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "simulcast-targets", ":SIMULCAST_TARGET_ID" ], "variable": [ { "id": "05021700-ca27-4b01-b2e2-607adc4e1068", "key": "LIVE_STREAM_ID", "value": "", "description": "(Required) The live stream ID" }, { "id": "8f91255a-347c-4e78-b973-60cfb9c61d02", "key": "SIMULCAST_TARGET_ID", "value": "", "description": "(Required) The ID of the simulcast target." } ] }, "description": "Retrieves the details of the simulcast target created for the parent live stream. Supply the unique live stream ID and simulcast target ID that was returned in the response of create simulcast target request, and Mux will return the corresponding information." }, "response": [ { "id": "05d34cae-b4fa-44b1-b0c1-f2bfe49b776c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/simulcast-targets/:SIMULCAST_TARGET_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "simulcast-targets", ":SIMULCAST_TARGET_ID" ], "variable": [ { "key": "LIVE_STREAM_ID" }, { "key": "SIMULCAST_TARGET_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"idle\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"fatal\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-05d34cae-b4fa-44b1-b0c1-f2bfe49b776c" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-55291881-5b88-4bb3-966c-327db780c2f7" } ], "id": "56392fa4-4d6e-4d39-819e-3c26accaa393", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-56392fa4-4d6e-4d39-819e-3c26accaa393" }, { "name": "Create a Live Stream Simulcast Target", "id": "e7cef7f9-5cc8-44d3-980a-1777e8d63dc8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"passthrough\": \"\",\n \"stream_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/simulcast-targets", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "simulcast-targets" ], "variable": [ { "id": "45ca68de-e0fa-4c08-88e5-ae0051beb9d1", "key": "LIVE_STREAM_ID", "value": "", "description": "(Required) The live stream ID" } ] }, "description": "Create a simulcast target for the parent live stream. Simulcast target can only be created when the parent live stream is in idle state. Only one simulcast target can be created at a time with this API." }, "response": [ { "id": "765bfaa6-2921-4465-a105-03dd386999eb", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"passthrough\": \"\",\n \"stream_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/simulcast-targets", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "simulcast-targets" ], "variable": [ { "key": "LIVE_STREAM_ID" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"idle\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"fatal\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-765bfaa6-2921-4465-a105-03dd386999eb" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e7cef7f9-5cc8-44d3-980a-1777e8d63dc8" } ], "id": "72cf9109-1add-410b-96ed-a5d38ed3ebbb", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-72cf9109-1add-410b-96ed-a5d38ed3ebbb" }, { "name": "new-asset-settings", "item": [ { "name": "static-renditions", "item": [ { "name": "Update Live Stream Static Renditions for New Assets", "id": "e082514f-2bf2-452e-93da-11e680e57d38", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"static_renditions\": [\n {\n \"resolution\": \"540p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"1080p\",\n \"passthrough\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/new-asset-settings/static-renditions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "new-asset-settings", "static-renditions" ], "variable": [ { "id": "294675b6-9253-4bac-bf9a-61c0150de191", "key": "LIVE_STREAM_ID", "value": "", "description": "(Required) The live stream ID" } ] }, "description": "Updates a live stream's static renditions settings for new assets. Further assets made via this live stream will create static renditions per the settings provided. You must provide all static renditions desired." }, "response": [ { "id": "fee88e43-9ce7-4735-b69f-1bfb82b95f82", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"static_renditions\": [\n {\n \"resolution\": \"540p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"1080p\",\n \"passthrough\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/new-asset-settings/static-renditions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "new-asset-settings", "static-renditions" ], "variable": [ { "key": "LIVE_STREAM_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"latency_mode\": \"standard\",\n \"max_continuous_duration\": 43200,\n \"status\": \"active\",\n \"stream_key\": \"\",\n \"active_asset_id\": \"\",\n \"recent_asset_ids\": [\n \"\",\n \"\"\n ],\n \"playback_ids\": [\n {\n \"id\": \"\",\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"id\": \"\",\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"public\",\n \"drm\"\n ],\n \"playback_policies\": [\n \"drm\",\n \"signed\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"capped-1080p\",\n \"normalize_audio\": false,\n \"master_access\": \"none\",\n \"test\": \"\",\n \"max_resolution_tier\": \"1440p\",\n \"encoding_tier\": \"premium\",\n \"video_quality\": \"premium\",\n \"static_renditions\": [\n {\n \"resolution\": \"2160p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"360p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"passthrough\": \"\",\n \"audio_only\": \"\",\n \"embedded_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n }\n ],\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"reconnect_window\": 60,\n \"use_slate_for_standard_latency\": false,\n \"reconnect_slate_url\": \"\",\n \"reduced_latency\": \"\",\n \"low_latency\": \"\",\n \"simulcast_targets\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"broadcasting\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"normal\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"starting\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"normal\"\n }\n ],\n \"test\": \"\",\n \"srt_passphrase\": \"\",\n \"active_ingest_protocol\": \"rtmp\",\n \"meta\": {\n \"title\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-fee88e43-9ce7-4735-b69f-1bfb82b95f82" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e082514f-2bf2-452e-93da-11e680e57d38" }, { "name": "Delete a Live Stream's Static Renditions Setting for New Assets", "id": "0098c372-61c1-4c2a-9acd-43c598dd55a4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/new-asset-settings/static-renditions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "new-asset-settings", "static-renditions" ], "variable": [ { "id": "ebfac7c9-769b-41d8-8b80-faadd0c0b492", "key": "LIVE_STREAM_ID", "value": "", "description": "(Required) The live stream ID" } ] }, "description": "Deletes a live stream's static renditions settings for new assets. Further assets made via this live stream will not create static renditions unless re-added." }, "response": [ { "id": "726db19f-493c-4770-8373-5d73a1390fd4", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID/new-asset-settings/static-renditions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID", "new-asset-settings", "static-renditions" ], "variable": [ { "key": "LIVE_STREAM_ID" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-726db19f-493c-4770-8373-5d73a1390fd4" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-0098c372-61c1-4c2a-9acd-43c598dd55a4" } ], "id": "a4dbc6d5-d582-4d4d-8de8-f07401012da8", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a4dbc6d5-d582-4d4d-8de8-f07401012da8" } ], "id": "96390a21-0b59-4311-b9b1-82433b21cc35", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-96390a21-0b59-4311-b9b1-82433b21cc35" }, { "name": "Retrieve a Live Stream", "id": "ad94ba2d-cbb9-4881-9269-9de48dd888ae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID" ], "variable": [ { "id": "6cd03748-5506-445f-8a96-130013be8afc", "key": "LIVE_STREAM_ID", "value": "", "description": "(Required) The live stream ID" } ] }, "description": "Retrieves the details of a live stream that has previously been created. Supply the unique live stream ID that was returned from your previous request, and Mux will return the corresponding live stream information. The same information is returned when creating a live stream." }, "response": [ { "id": "618bd685-c193-4974-9775-094c4baac061", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID" ], "variable": [ { "key": "LIVE_STREAM_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"latency_mode\": \"standard\",\n \"max_continuous_duration\": 43200,\n \"status\": \"active\",\n \"stream_key\": \"\",\n \"active_asset_id\": \"\",\n \"recent_asset_ids\": [\n \"\",\n \"\"\n ],\n \"playback_ids\": [\n {\n \"id\": \"\",\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"id\": \"\",\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"public\",\n \"drm\"\n ],\n \"playback_policies\": [\n \"drm\",\n \"signed\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"capped-1080p\",\n \"normalize_audio\": false,\n \"master_access\": \"none\",\n \"test\": \"\",\n \"max_resolution_tier\": \"1440p\",\n \"encoding_tier\": \"premium\",\n \"video_quality\": \"premium\",\n \"static_renditions\": [\n {\n \"resolution\": \"2160p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"360p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"passthrough\": \"\",\n \"audio_only\": \"\",\n \"embedded_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n }\n ],\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"reconnect_window\": 60,\n \"use_slate_for_standard_latency\": false,\n \"reconnect_slate_url\": \"\",\n \"reduced_latency\": \"\",\n \"low_latency\": \"\",\n \"simulcast_targets\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"broadcasting\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"normal\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"starting\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"normal\"\n }\n ],\n \"test\": \"\",\n \"srt_passphrase\": \"\",\n \"active_ingest_protocol\": \"rtmp\",\n \"meta\": {\n \"title\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-618bd685-c193-4974-9775-094c4baac061" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-ad94ba2d-cbb9-4881-9269-9de48dd888ae" }, { "name": "Delete a Live Stream", "id": "8c9eb818-5db2-4c7f-b9bf-9e03236c6504", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID" ], "variable": [ { "id": "565f83e4-5e72-4b3a-a6bd-8492fd88ff74", "key": "LIVE_STREAM_ID", "value": "", "description": "(Required) The live stream ID" } ] }, "description": "Deletes a live stream from the current environment. If the live stream is currently active and being streamed to, ingest will be terminated and the encoder will be disconnected." }, "response": [ { "id": "8e5a3a62-0dc4-4e49-8939-4f96f592f046", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID" ], "variable": [ { "key": "LIVE_STREAM_ID" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-8e5a3a62-0dc4-4e49-8939-4f96f592f046" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-8c9eb818-5db2-4c7f-b9bf-9e03236c6504" }, { "name": "Update a Live Stream", "id": "398a9d76-f859-4524-8ff1-ebd9aa0b2c8c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"passthrough\": \"\",\n \"latency_mode\": \"reduced\",\n \"reconnect_window\": 60,\n \"use_slate_for_standard_latency\": false,\n \"reconnect_slate_url\": \"\",\n \"max_continuous_duration\": 43200,\n \"new_asset_settings\": {\n \"mp4_support\": \"standard\",\n \"master_access\": \"none\",\n \"video_quality\": \"premium\",\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID" ], "variable": [ { "id": "df9c5852-f2e8-48c7-9696-1dede525f8c1", "key": "LIVE_STREAM_ID", "value": "", "description": "(Required) The live stream ID" } ] }, "description": "Updates the parameters of a previously-created live stream. This currently supports a subset of variables. Supply the live stream ID and the updated parameters and Mux will return the corresponding live stream information. The information returned will be the same after update as for subsequent get live stream requests." }, "response": [ { "id": "9183742e-f936-4039-a429-f9678ba3f739", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"passthrough\": \"\",\n \"latency_mode\": \"reduced\",\n \"reconnect_window\": 60,\n \"use_slate_for_standard_latency\": false,\n \"reconnect_slate_url\": \"\",\n \"max_continuous_duration\": 43200,\n \"new_asset_settings\": {\n \"mp4_support\": \"standard\",\n \"master_access\": \"none\",\n \"video_quality\": \"premium\",\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/live-streams/:LIVE_STREAM_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams", ":LIVE_STREAM_ID" ], "variable": [ { "key": "LIVE_STREAM_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"latency_mode\": \"standard\",\n \"max_continuous_duration\": 43200,\n \"status\": \"active\",\n \"stream_key\": \"\",\n \"active_asset_id\": \"\",\n \"recent_asset_ids\": [\n \"\",\n \"\"\n ],\n \"playback_ids\": [\n {\n \"id\": \"\",\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"id\": \"\",\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"public\",\n \"drm\"\n ],\n \"playback_policies\": [\n \"drm\",\n \"signed\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"capped-1080p\",\n \"normalize_audio\": false,\n \"master_access\": \"none\",\n \"test\": \"\",\n \"max_resolution_tier\": \"1440p\",\n \"encoding_tier\": \"premium\",\n \"video_quality\": \"premium\",\n \"static_renditions\": [\n {\n \"resolution\": \"2160p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"360p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"passthrough\": \"\",\n \"audio_only\": \"\",\n \"embedded_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n }\n ],\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"reconnect_window\": 60,\n \"use_slate_for_standard_latency\": false,\n \"reconnect_slate_url\": \"\",\n \"reduced_latency\": \"\",\n \"low_latency\": \"\",\n \"simulcast_targets\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"broadcasting\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"normal\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"starting\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"normal\"\n }\n ],\n \"test\": \"\",\n \"srt_passphrase\": \"\",\n \"active_ingest_protocol\": \"rtmp\",\n \"meta\": {\n \"title\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-9183742e-f936-4039-a429-f9678ba3f739" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-398a9d76-f859-4524-8ff1-ebd9aa0b2c8c" } ], "id": "cfdd7cc6-ce08-4c05-811a-98b4e2694ace", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-cfdd7cc6-ce08-4c05-811a-98b4e2694ace" }, { "name": "Create a Live Stream", "id": "bee84975-0254-4bb6-8907-ef4447298289", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"playback_policy\": [\n \"signed\",\n \"drm\"\n ],\n \"playback_policies\": [\n \"signed\",\n \"public\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"audio\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"audio\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"audio\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"signed\",\n \"public\"\n ],\n \"playback_policies\": [\n \"drm\",\n \"public\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"none\",\n \"normalize_audio\": false,\n \"master_access\": \"temporary\",\n \"test\": \"\",\n \"max_resolution_tier\": \"1080p\",\n \"encoding_tier\": \"premium\",\n \"video_quality\": \"basic\",\n \"static_renditions\": [\n {\n \"resolution\": \"720p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"1080p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"reconnect_window\": 60,\n \"use_slate_for_standard_latency\": false,\n \"reconnect_slate_url\": \"\",\n \"passthrough\": \"\",\n \"audio_only\": \"\",\n \"embedded_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\"\n }\n ],\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"reduced_latency\": \"\",\n \"low_latency\": \"\",\n \"latency_mode\": \"reduced\",\n \"test\": \"\",\n \"simulcast_targets\": [\n {\n \"url\": \"\",\n \"passthrough\": \"\",\n \"stream_key\": \"\"\n },\n {\n \"url\": \"\",\n \"passthrough\": \"\",\n \"stream_key\": \"\"\n }\n ],\n \"max_continuous_duration\": 43200,\n \"meta\": {\n \"title\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/live-streams", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams" ] }, "description": "Creates a new live stream. Once created, an encoder can connect to Mux via the specified stream key and begin streaming to an audience." }, "response": [ { "id": "3cff738f-ccfe-47f2-a902-0fef01ba18e7", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"playback_policy\": [\n \"signed\",\n \"drm\"\n ],\n \"playback_policies\": [\n \"signed\",\n \"public\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"audio\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"audio\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"audio\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"signed\",\n \"public\"\n ],\n \"playback_policies\": [\n \"drm\",\n \"public\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"none\",\n \"normalize_audio\": false,\n \"master_access\": \"temporary\",\n \"test\": \"\",\n \"max_resolution_tier\": \"1080p\",\n \"encoding_tier\": \"premium\",\n \"video_quality\": \"basic\",\n \"static_renditions\": [\n {\n \"resolution\": \"720p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"1080p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"reconnect_window\": 60,\n \"use_slate_for_standard_latency\": false,\n \"reconnect_slate_url\": \"\",\n \"passthrough\": \"\",\n \"audio_only\": \"\",\n \"embedded_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\"\n }\n ],\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"reduced_latency\": \"\",\n \"low_latency\": \"\",\n \"latency_mode\": \"reduced\",\n \"test\": \"\",\n \"simulcast_targets\": [\n {\n \"url\": \"\",\n \"passthrough\": \"\",\n \"stream_key\": \"\"\n },\n {\n \"url\": \"\",\n \"passthrough\": \"\",\n \"stream_key\": \"\"\n }\n ],\n \"max_continuous_duration\": 43200,\n \"meta\": {\n \"title\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/live-streams", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"latency_mode\": \"standard\",\n \"max_continuous_duration\": 43200,\n \"status\": \"active\",\n \"stream_key\": \"\",\n \"active_asset_id\": \"\",\n \"recent_asset_ids\": [\n \"\",\n \"\"\n ],\n \"playback_ids\": [\n {\n \"id\": \"\",\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"id\": \"\",\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"public\",\n \"drm\"\n ],\n \"playback_policies\": [\n \"drm\",\n \"signed\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"capped-1080p\",\n \"normalize_audio\": false,\n \"master_access\": \"none\",\n \"test\": \"\",\n \"max_resolution_tier\": \"1440p\",\n \"encoding_tier\": \"premium\",\n \"video_quality\": \"premium\",\n \"static_renditions\": [\n {\n \"resolution\": \"2160p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"360p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"passthrough\": \"\",\n \"audio_only\": \"\",\n \"embedded_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n }\n ],\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"reconnect_window\": 60,\n \"use_slate_for_standard_latency\": false,\n \"reconnect_slate_url\": \"\",\n \"reduced_latency\": \"\",\n \"low_latency\": \"\",\n \"simulcast_targets\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"broadcasting\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"normal\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"starting\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"normal\"\n }\n ],\n \"test\": \"\",\n \"srt_passphrase\": \"\",\n \"active_ingest_protocol\": \"rtmp\",\n \"meta\": {\n \"title\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-3cff738f-ccfe-47f2-a902-0fef01ba18e7" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-bee84975-0254-4bb6-8907-ef4447298289" }, { "name": "List Live Streams", "id": "57c83a24-dbf8-4b95-a9c6-e218671417b5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/live-streams?limit=25&page=1&stream_key=&status=disabled", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Filter response to return live stream for this stream key only", "key": "stream_key", "value": "" }, { "description": "Filter response to return live streams with the specified status only", "key": "status", "value": "disabled" } ] }, "description": "Lists the live streams that currently exist in the current environment." }, "response": [ { "id": "0a71bdfb-f5b7-441d-b1f0-df7275e235e2", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/live-streams?limit=25&page=1&stream_key=&status=disabled", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "live-streams" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Filter response to return live stream for this stream key only", "key": "stream_key", "value": "" }, { "description": "Filter response to return live streams with the specified status only", "key": "status", "value": "disabled" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"latency_mode\": \"reduced\",\n \"max_continuous_duration\": 43200,\n \"status\": \"idle\",\n \"stream_key\": \"\",\n \"active_asset_id\": \"\",\n \"recent_asset_ids\": [\n \"\",\n \"\"\n ],\n \"playback_ids\": [\n {\n \"id\": \"\",\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"id\": \"\",\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"audio\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"audio\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"drm\",\n \"drm\"\n ],\n \"playback_policies\": [\n \"drm\",\n \"public\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"standard\",\n \"normalize_audio\": false,\n \"master_access\": \"none\",\n \"test\": \"\",\n \"max_resolution_tier\": \"2160p\",\n \"encoding_tier\": \"smart\",\n \"video_quality\": \"premium\",\n \"static_renditions\": [\n {\n \"resolution\": \"360p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"720p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"passthrough\": \"\",\n \"audio_only\": \"\",\n \"embedded_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n }\n ],\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"reconnect_window\": 60,\n \"use_slate_for_standard_latency\": false,\n \"reconnect_slate_url\": \"\",\n \"reduced_latency\": \"\",\n \"low_latency\": \"\",\n \"simulcast_targets\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"idle\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"normal\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"starting\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"normal\"\n }\n ],\n \"test\": \"\",\n \"srt_passphrase\": \"\",\n \"active_ingest_protocol\": \"srt\",\n \"meta\": {\n \"title\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"latency_mode\": \"standard\",\n \"max_continuous_duration\": 43200,\n \"status\": \"disabled\",\n \"stream_key\": \"\",\n \"active_asset_id\": \"\",\n \"recent_asset_ids\": [\n \"\",\n \"\"\n ],\n \"playback_ids\": [\n {\n \"id\": \"\",\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"id\": \"\",\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"audio\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"audio\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"signed\",\n \"public\"\n ],\n \"playback_policies\": [\n \"signed\",\n \"public\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"audio-only,capped-1080p\",\n \"normalize_audio\": false,\n \"master_access\": \"none\",\n \"test\": \"\",\n \"max_resolution_tier\": \"1440p\",\n \"encoding_tier\": \"baseline\",\n \"video_quality\": \"plus\",\n \"static_renditions\": [\n {\n \"resolution\": \"1440p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"1080p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"passthrough\": \"\",\n \"audio_only\": \"\",\n \"embedded_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"language_channel\": \"cc1\",\n \"passthrough\": \"\"\n }\n ],\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"language_code\": \"en\",\n \"passthrough\": \"\",\n \"transcription_vocabulary_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"reconnect_window\": 60,\n \"use_slate_for_standard_latency\": false,\n \"reconnect_slate_url\": \"\",\n \"reduced_latency\": \"\",\n \"low_latency\": \"\",\n \"simulcast_targets\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"errored\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"fatal\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"status\": \"idle\",\n \"passthrough\": \"\",\n \"stream_key\": \"\",\n \"error_severity\": \"fatal\"\n }\n ],\n \"test\": \"\",\n \"srt_passphrase\": \"\",\n \"active_ingest_protocol\": \"rtmp\",\n \"meta\": {\n \"title\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-0a71bdfb-f5b7-441d-b1f0-df7275e235e2" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-57c83a24-dbf8-4b95-a9c6-e218671417b5" } ], "id": "178dd5dd-7f89-4f9c-b942-c73b25ccd092", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-178dd5dd-7f89-4f9c-b942-c73b25ccd092" }, { "name": "playback-ids", "item": [ { "name": "{PLAYBACK_ID}", "item": [ { "name": "Retrieve an Asset or Live Stream ID", "id": "7bafbdad-387a-449f-874b-03187abab1fa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/playback-ids/:PLAYBACK_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "playback-ids", ":PLAYBACK_ID" ], "variable": [ { "id": "ead62ca6-46a0-4bd3-9cac-7e28554f4fa5", "key": "PLAYBACK_ID", "value": "", "description": "(Required) The asset or live stream's playback ID." } ] }, "description": "Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID." }, "response": [ { "id": "4361e629-1741-4439-8b65-25e51b059955", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/playback-ids/:PLAYBACK_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "playback-ids", ":PLAYBACK_ID" ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"live_stream\"\n },\n \"policy\": \"drm\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-4361e629-1741-4439-8b65-25e51b059955" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-7bafbdad-387a-449f-874b-03187abab1fa" } ], "id": "a5ec10d8-b31f-4510-8aa5-c87af8624b57", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a5ec10d8-b31f-4510-8aa5-c87af8624b57" } ], "id": "e2bd6649-7b37-41bc-a328-ec80346fbf8c", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e2bd6649-7b37-41bc-a328-ec80346fbf8c" }, { "name": "signing-keys", "item": [ { "name": "{SIGNING_KEY_ID}", "item": [ { "name": "Retrieve a URL Signing Key", "id": "20d17158-513a-4755-b0f0-1a88ce741d31", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/signing-keys/:SIGNING_KEY_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "signing-keys", ":SIGNING_KEY_ID" ], "variable": [ { "id": "7dd24fe3-3cde-4bc2-a4e7-ffcb0a8dce23", "key": "SIGNING_KEY_ID", "value": "", "description": "(Required) The ID of the signing key." } ] }, "description": "This route is now deprecated, please use the `Signing Keys` API. Retrieves the details of a URL signing key that has previously\nbeen created. Supply the unique signing key ID that was returned from your\nprevious request, and Mux will return the corresponding signing key information.\n**The private key is not returned in this response.**\n\nNote: Any new access tokens authenticating this route will be required to have `System` level permissions.\n" }, "response": [ { "id": "247840a9-d576-43f4-83df-7967712ffaf1", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/signing-keys/:SIGNING_KEY_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "signing-keys", ":SIGNING_KEY_ID" ], "variable": [ { "key": "SIGNING_KEY_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"private_key\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-247840a9-d576-43f4-83df-7967712ffaf1" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-20d17158-513a-4755-b0f0-1a88ce741d31" }, { "name": "Delete a URL Signing Key", "id": "b7af0e18-95bc-4565-a433-424341c0f457", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "https://api.mux.com/video/v1/signing-keys/:SIGNING_KEY_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "signing-keys", ":SIGNING_KEY_ID" ], "variable": [ { "id": "2c8a0a84-3674-464b-bf3f-e1e4314c1af6", "key": "SIGNING_KEY_ID", "value": "", "description": "(Required) The ID of the signing key." } ] }, "description": "This route is now deprecated, please use the `Signing Keys` API. Deletes an existing signing key. Use with caution, as this will\ninvalidate any existing signatures and no URLs can be signed using the key\nagain.\n\nNote: Any new access tokens authenticating this route will be required to have `System` level permissions.\n" }, "response": [ { "id": "b7eef8b3-982b-4045-a955-10716eed9705", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/signing-keys/:SIGNING_KEY_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "signing-keys", ":SIGNING_KEY_ID" ], "variable": [ { "key": "SIGNING_KEY_ID" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b7eef8b3-982b-4045-a955-10716eed9705" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b7af0e18-95bc-4565-a433-424341c0f457" } ], "id": "3d410da6-8d48-4ffa-8250-3bbc395e7ce1", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-3d410da6-8d48-4ffa-8250-3bbc395e7ce1" }, { "name": "Create a URL Signing Key", "id": "5235c153-b441-409f-97fc-2cca451372f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/signing-keys", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "signing-keys" ] }, "description": "This route is now deprecated, please use the `Signing Keys` API. Creates a new signing key pair. When creating a new signing key,\nthe API will generate a 2048-bit RSA key-pair and return the private key and\na generated key-id; the public key will be stored at Mux to validate signed\ntokens.\n\nNote: Any new access tokens authenticating this route will be required to have `System` level permissions.\n" }, "response": [ { "id": "1cef6cd8-5b9a-497a-b31e-27ebef5cc041", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/signing-keys", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "signing-keys" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"created_at\": \"\",\n \"id\": \"\",\n \"private_key\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-1cef6cd8-5b9a-497a-b31e-27ebef5cc041" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-5235c153-b441-409f-97fc-2cca451372f7" }, { "name": "List URL Signing Keys", "id": "74393005-f284-4991-8dfc-7efc4ac01c2d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/signing-keys?limit=25&page=1", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "signing-keys" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" } ] }, "description": "This route is now deprecated, please use the `Signing Keys` API. Returns a list of URL signing keys.\n\nNote: Any new access tokens authenticating this route will be required to have `System` level permissions.\n" }, "response": [ { "id": "00920526-4c89-4b22-8fd8-39f0dc9c8471", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/signing-keys?limit=25&page=1", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "signing-keys" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"private_key\": \"\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"private_key\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-00920526-4c89-4b22-8fd8-39f0dc9c8471" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-74393005-f284-4991-8dfc-7efc4ac01c2d" } ], "id": "e99c9755-a80c-4e13-88b8-38088aacc2b5", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e99c9755-a80c-4e13-88b8-38088aacc2b5" }, { "name": "uploads", "item": [ { "name": "{UPLOAD_ID}", "item": [ { "name": "cancel", "item": [ { "name": "Cancel a Direct Upload", "id": "725935b3-b982-45f9-9fe7-8fb79537e1b3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/uploads/:UPLOAD_ID/cancel", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "uploads", ":UPLOAD_ID", "cancel" ], "variable": [ { "id": "e8f90b53-f101-461a-94ed-be2f2e35f616", "key": "UPLOAD_ID", "value": "", "description": "(Required) ID of the Upload" } ] }, "description": "Cancels a direct upload and marks it as cancelled. If a pending upload finishes after this\nrequest, no asset will be created. This request will only succeed if the upload is still in\nthe `waiting` state.\n" }, "response": [ { "id": "369b04c3-9146-4e04-9d33-ed99843b9365", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/uploads/:UPLOAD_ID/cancel", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "uploads", ":UPLOAD_ID", "cancel" ], "variable": [ { "key": "UPLOAD_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"timeout\": 3600,\n \"status\": \"cancelled\",\n \"cors_origin\": \"\",\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"public\",\n \"public\"\n ],\n \"playback_policies\": [\n \"drm\",\n \"signed\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"none\",\n \"normalize_audio\": false,\n \"master_access\": \"temporary\",\n \"test\": \"\",\n \"max_resolution_tier\": \"1440p\",\n \"encoding_tier\": \"baseline\",\n \"video_quality\": \"plus\",\n \"static_renditions\": [\n {\n \"resolution\": \"480p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"540p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"asset_id\": \"\",\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n },\n \"url\": \"\",\n \"test\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-369b04c3-9146-4e04-9d33-ed99843b9365" }, { "id": "af703f6a-cd4a-4aeb-9f6d-8a5d9af1d5a7", "name": "Cancellation no longer possible", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/uploads/:UPLOAD_ID/cancel", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "uploads", ":UPLOAD_ID", "cancel" ], "variable": [ { "key": "UPLOAD_ID" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-af703f6a-cd4a-4aeb-9f6d-8a5d9af1d5a7" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-725935b3-b982-45f9-9fe7-8fb79537e1b3" } ], "id": "5d642e37-e930-4a1d-b37f-650de45fb111", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-5d642e37-e930-4a1d-b37f-650de45fb111" }, { "name": "Retrieve a Single Direct Upload's Info", "id": "f27084c8-35ab-40b3-9896-924f7107fad0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/uploads/:UPLOAD_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "uploads", ":UPLOAD_ID" ], "variable": [ { "id": "a445a819-83c2-472b-8517-6d8dad270c79", "key": "UPLOAD_ID", "value": "", "description": "(Required) ID of the Upload" } ] }, "description": "Fetches information about a single direct upload in the current environment." }, "response": [ { "id": "a152532f-3cfc-4a6b-876c-7ab1b0e2804e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/uploads/:UPLOAD_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "uploads", ":UPLOAD_ID" ], "variable": [ { "key": "UPLOAD_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"timeout\": 3600,\n \"status\": \"cancelled\",\n \"cors_origin\": \"\",\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"public\",\n \"public\"\n ],\n \"playback_policies\": [\n \"drm\",\n \"signed\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"none\",\n \"normalize_audio\": false,\n \"master_access\": \"temporary\",\n \"test\": \"\",\n \"max_resolution_tier\": \"1440p\",\n \"encoding_tier\": \"baseline\",\n \"video_quality\": \"plus\",\n \"static_renditions\": [\n {\n \"resolution\": \"480p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"540p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"asset_id\": \"\",\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n },\n \"url\": \"\",\n \"test\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a152532f-3cfc-4a6b-876c-7ab1b0e2804e" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f27084c8-35ab-40b3-9896-924f7107fad0" } ], "id": "7fa57f97-1cd4-414f-b9ce-8cad38662168", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-7fa57f97-1cd4-414f-b9ce-8cad38662168" }, { "name": "Create a New Direct Upload URL", "id": "89cbae3c-b5bc-43d9-94e0-ae4b3683b5b9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cors_origin\": \"\",\n \"timeout\": 3600,\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"drm\",\n \"public\"\n ],\n \"playback_policies\": [\n \"signed\",\n \"drm\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"standard\",\n \"normalize_audio\": false,\n \"master_access\": \"none\",\n \"test\": \"\",\n \"max_resolution_tier\": \"2160p\",\n \"encoding_tier\": \"smart\",\n \"video_quality\": \"plus\",\n \"static_renditions\": [\n {\n \"resolution\": \"2160p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"720p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"test\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/uploads", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "uploads" ] }, "description": "Creates a new direct upload, through which video content can be uploaded for ingest to Mux." }, "response": [ { "id": "a18f6ce9-8774-4df2-bf4a-ed6c29e8673a", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"cors_origin\": \"\",\n \"timeout\": 3600,\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"drm\",\n \"public\"\n ],\n \"playback_policies\": [\n \"signed\",\n \"drm\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"standard\",\n \"normalize_audio\": false,\n \"master_access\": \"none\",\n \"test\": \"\",\n \"max_resolution_tier\": \"2160p\",\n \"encoding_tier\": \"smart\",\n \"video_quality\": \"plus\",\n \"static_renditions\": [\n {\n \"resolution\": \"2160p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"720p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"test\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/uploads", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "uploads" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"timeout\": 3600,\n \"status\": \"cancelled\",\n \"cors_origin\": \"\",\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"public\",\n \"public\"\n ],\n \"playback_policies\": [\n \"drm\",\n \"signed\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"none\",\n \"normalize_audio\": false,\n \"master_access\": \"temporary\",\n \"test\": \"\",\n \"max_resolution_tier\": \"1440p\",\n \"encoding_tier\": \"baseline\",\n \"video_quality\": \"plus\",\n \"static_renditions\": [\n {\n \"resolution\": \"480p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"540p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"asset_id\": \"\",\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n },\n \"url\": \"\",\n \"test\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a18f6ce9-8774-4df2-bf4a-ed6c29e8673a" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-89cbae3c-b5bc-43d9-94e0-ae4b3683b5b9" }, { "name": "List Direct Uploads", "id": "a6ea0ac5-2caf-4d85-8e5d-ff3cf5db3c9b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/uploads?limit=25&page=1", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "uploads" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" } ] }, "description": "Lists direct uploads in the current environment." }, "response": [ { "id": "b4206b9a-2158-4547-837b-a05a0164bd91", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/uploads?limit=25&page=1", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "uploads" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"timeout\": 3600,\n \"status\": \"cancelled\",\n \"cors_origin\": \"\",\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"bottom\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"center\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"video\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"public\",\n \"drm\"\n ],\n \"playback_policies\": [\n \"public\",\n \"drm\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"signed\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"none\",\n \"normalize_audio\": false,\n \"master_access\": \"none\",\n \"test\": \"\",\n \"max_resolution_tier\": \"1080p\",\n \"encoding_tier\": \"smart\",\n \"video_quality\": \"plus\",\n \"static_renditions\": [\n {\n \"resolution\": \"270p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"270p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"asset_id\": \"\",\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n },\n \"url\": \"\",\n \"test\": \"\"\n },\n {\n \"id\": \"\",\n \"timeout\": 3600,\n \"status\": \"asset_created\",\n \"cors_origin\": \"\",\n \"new_asset_settings\": {\n \"input\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"right\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"audio\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"top\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"text\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"inputs\": [\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"audio\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n },\n {\n \"url\": \"\",\n \"overlay_settings\": {\n \"vertical_align\": \"middle\",\n \"vertical_margin\": \"\",\n \"horizontal_align\": \"left\",\n \"horizontal_margin\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"opacity\": \"\"\n },\n \"generated_subtitles\": [\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n },\n {\n \"name\": \"\",\n \"passthrough\": \"\",\n \"language_code\": \"en\"\n }\n ],\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"type\": \"audio\",\n \"text_type\": \"subtitles\",\n \"language_code\": \"\",\n \"name\": \"\",\n \"closed_captions\": \"\",\n \"passthrough\": \"\"\n }\n ],\n \"playback_policy\": [\n \"public\",\n \"signed\"\n ],\n \"playback_policies\": [\n \"public\",\n \"signed\"\n ],\n \"advanced_playback_policies\": [\n {\n \"policy\": \"public\",\n \"drm_configuration_id\": \"\"\n },\n {\n \"policy\": \"drm\",\n \"drm_configuration_id\": \"\"\n }\n ],\n \"per_title_encode\": \"\",\n \"passthrough\": \"\",\n \"mp4_support\": \"standard\",\n \"normalize_audio\": false,\n \"master_access\": \"none\",\n \"test\": \"\",\n \"max_resolution_tier\": \"1440p\",\n \"encoding_tier\": \"baseline\",\n \"video_quality\": \"plus\",\n \"static_renditions\": [\n {\n \"resolution\": \"720p\",\n \"passthrough\": \"\"\n },\n {\n \"resolution\": \"1440p\",\n \"passthrough\": \"\"\n }\n ],\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"copy_overlays\": true\n },\n \"asset_id\": \"\",\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n },\n \"url\": \"\",\n \"test\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b4206b9a-2158-4547-837b-a05a0164bd91" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a6ea0ac5-2caf-4d85-8e5d-ff3cf5db3c9b" } ], "id": "91d8ae04-fcf7-441b-974b-593975ee1961", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-91d8ae04-fcf7-441b-974b-593975ee1961" }, { "name": "delivery-usage", "item": [ { "name": "List Usage", "id": "c726ee23-c1bd-46c0-aae6-c3547b2b34b8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/delivery-usage?page=1&limit=100&asset_id=&live_stream_id=&timeframe[]=&timeframe[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "delivery-usage" ], "query": [ { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Number of items to include in the response", "key": "limit", "value": "100" }, { "description": "Filter response to return delivery usage for this asset only. You cannot specify both the `asset_id` and `live_stream_id` parameters together.", "key": "asset_id", "value": "" }, { "description": "Filter response to return delivery usage for assets for this live stream. You cannot specify both the `asset_id` and `live_stream_id` parameters together.", "key": "live_stream_id", "value": "" }, { "description": "Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made.", "key": "timeframe[]", "value": "" }, { "description": "Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made.", "key": "timeframe[]", "value": "" } ] }, "description": "Returns a list of delivery usage records and their associated Asset IDs or Live Stream IDs." }, "response": [ { "id": "436860a0-6ecc-45da-bea1-7491853ce5a0", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/delivery-usage?page=1&limit=100&asset_id=&live_stream_id=&timeframe[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "delivery-usage" ], "query": [ { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Number of items to include in the response", "key": "limit", "value": "100" }, { "description": "Filter response to return delivery usage for this asset only. You cannot specify both the `asset_id` and `live_stream_id` parameters together.", "key": "asset_id", "value": "" }, { "description": "Filter response to return delivery usage for assets for this live stream. You cannot specify both the `asset_id` and `live_stream_id` parameters together.", "key": "live_stream_id", "value": "" }, { "description": "Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made.", "key": "timeframe[]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"asset_id\": \"\",\n \"asset_state\": \"errored\",\n \"asset_resolution_tier\": \"720p\",\n \"asset_encoding_tier\": \"smart\",\n \"asset_duration\": \"\",\n \"created_at\": \"\",\n \"delivered_seconds\": \"\",\n \"delivered_seconds_by_resolution\": {\n \"tier_2160p\": \"\",\n \"tier_1440p\": \"\",\n \"tier_1080p\": \"\",\n \"tier_720p\": \"\",\n \"tier_audio_only\": \"\"\n },\n \"live_stream_id\": \"\",\n \"passthrough\": \"\",\n \"deleted_at\": \"\",\n \"asset_video_quality\": \"basic\"\n },\n {\n \"asset_id\": \"\",\n \"asset_state\": \"errored\",\n \"asset_resolution_tier\": \"2160p\",\n \"asset_encoding_tier\": \"smart\",\n \"asset_duration\": \"\",\n \"created_at\": \"\",\n \"delivered_seconds\": \"\",\n \"delivered_seconds_by_resolution\": {\n \"tier_2160p\": \"\",\n \"tier_1440p\": \"\",\n \"tier_1080p\": \"\",\n \"tier_720p\": \"\",\n \"tier_audio_only\": \"\"\n },\n \"live_stream_id\": \"\",\n \"passthrough\": \"\",\n \"deleted_at\": \"\",\n \"asset_video_quality\": \"plus\"\n }\n ],\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"limit\": \"\",\n \"total_row_count\": \"\",\n \"page\": true\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-436860a0-6ecc-45da-bea1-7491853ce5a0" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-c726ee23-c1bd-46c0-aae6-c3547b2b34b8" } ], "id": "d8541b24-f0d5-4b9a-ab2a-97b6a646d528", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-d8541b24-f0d5-4b9a-ab2a-97b6a646d528" }, { "name": "playback-restrictions", "item": [ { "name": "{PLAYBACK_RESTRICTION_ID}", "item": [ { "name": "referrer", "item": [ { "name": "Update the Referrer Playback Restriction", "id": "2ee75b54-8f43-4c34-9a30-68f24a0bfc6a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"allowed_domains\": [\n \"\",\n \"\"\n ],\n \"allow_no_referrer\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/playback-restrictions/:PLAYBACK_RESTRICTION_ID/referrer", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "playback-restrictions", ":PLAYBACK_RESTRICTION_ID", "referrer" ], "variable": [ { "id": "b16c1aaa-42e8-41d5-842e-ec1ecd71266e", "key": "PLAYBACK_RESTRICTION_ID", "value": "", "description": "(Required) ID of the Playback Restriction." } ] }, "description": "Allows you to modify the list of domains or change how Mux validates playback requests without the `Referer` HTTP header. The Referrer restriction fully replaces the old list with this new list of domains." }, "response": [ { "id": "ab9f668f-bc67-4555-97de-dfc9be31a87c", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"allowed_domains\": [\n \"\",\n \"\"\n ],\n \"allow_no_referrer\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/playback-restrictions/:PLAYBACK_RESTRICTION_ID/referrer", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "playback-restrictions", ":PLAYBACK_RESTRICTION_ID", "referrer" ], "variable": [ { "key": "PLAYBACK_RESTRICTION_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"referrer\": {\n \"allowed_domains\": [\n \"\",\n \"\"\n ],\n \"allow_no_referrer\": false\n },\n \"user_agent\": {\n \"allow_no_user_agent\": true,\n \"allow_high_risk_user_agent\": true\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-ab9f668f-bc67-4555-97de-dfc9be31a87c" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-2ee75b54-8f43-4c34-9a30-68f24a0bfc6a" } ], "id": "c957e889-cb4d-41fb-8e41-30021d2ab05d", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-c957e889-cb4d-41fb-8e41-30021d2ab05d" }, { "name": "user_agent", "item": [ { "name": "Update the User Agent Restriction", "id": "0d0588eb-0613-4c27-9eb8-9d470978fa73", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"allow_no_user_agent\": true,\n \"allow_high_risk_user_agent\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/playback-restrictions/:PLAYBACK_RESTRICTION_ID/user_agent", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "playback-restrictions", ":PLAYBACK_RESTRICTION_ID", "user_agent" ], "variable": [ { "id": "31213cf2-418b-414c-be24-f76b9ab2d911", "key": "PLAYBACK_RESTRICTION_ID", "value": "", "description": "(Required) ID of the Playback Restriction." } ] }, "description": "Allows you to modify how Mux validates playback requests with different user agents. Please see [Using User-Agent HTTP header for validation](https://docs.mux.com/guides/secure-video-playback#using-user-agent-http-header-for-validation) for more details on this feature." }, "response": [ { "id": "e563001d-56e8-4104-a685-6c61b4fbbf14", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"allow_no_user_agent\": true,\n \"allow_high_risk_user_agent\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/playback-restrictions/:PLAYBACK_RESTRICTION_ID/user_agent", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "playback-restrictions", ":PLAYBACK_RESTRICTION_ID", "user_agent" ], "variable": [ { "key": "PLAYBACK_RESTRICTION_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"referrer\": {\n \"allowed_domains\": [\n \"\",\n \"\"\n ],\n \"allow_no_referrer\": false\n },\n \"user_agent\": {\n \"allow_no_user_agent\": true,\n \"allow_high_risk_user_agent\": true\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e563001d-56e8-4104-a685-6c61b4fbbf14" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-0d0588eb-0613-4c27-9eb8-9d470978fa73" } ], "id": "a11fa771-f388-4c09-a160-febfa2c6f416", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a11fa771-f388-4c09-a160-febfa2c6f416" }, { "name": "Delete a Playback Restriction", "id": "20bb83f1-751a-44f1-a76e-d3048fa40cb3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "https://api.mux.com/video/v1/playback-restrictions/:PLAYBACK_RESTRICTION_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "playback-restrictions", ":PLAYBACK_RESTRICTION_ID" ], "variable": [ { "id": "2c4c79e9-918f-4311-a53e-907f93bd738b", "key": "PLAYBACK_RESTRICTION_ID", "value": "", "description": "(Required) ID of the Playback Restriction." } ] }, "description": "Deletes a single Playback Restriction." }, "response": [ { "id": "c825f8ad-272a-4080-8ef7-5224dbe3285f", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/playback-restrictions/:PLAYBACK_RESTRICTION_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "playback-restrictions", ":PLAYBACK_RESTRICTION_ID" ], "variable": [ { "key": "PLAYBACK_RESTRICTION_ID" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-c825f8ad-272a-4080-8ef7-5224dbe3285f" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-20bb83f1-751a-44f1-a76e-d3048fa40cb3" }, { "name": "Retrieve a Playback Restriction", "id": "4e669fa4-6af7-4ad1-ab9d-19382931f709", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/playback-restrictions/:PLAYBACK_RESTRICTION_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "playback-restrictions", ":PLAYBACK_RESTRICTION_ID" ], "variable": [ { "id": "71e53a1b-be1a-483e-b6d5-143d98fbfaf5", "key": "PLAYBACK_RESTRICTION_ID", "value": "", "description": "(Required) ID of the Playback Restriction." } ] }, "description": "Retrieves a Playback Restriction associated with the unique identifier." }, "response": [ { "id": "3295aef7-38ea-4797-a79d-b1534f483805", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/playback-restrictions/:PLAYBACK_RESTRICTION_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "playback-restrictions", ":PLAYBACK_RESTRICTION_ID" ], "variable": [ { "key": "PLAYBACK_RESTRICTION_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"referrer\": {\n \"allowed_domains\": [\n \"\",\n \"\"\n ],\n \"allow_no_referrer\": false\n },\n \"user_agent\": {\n \"allow_no_user_agent\": true,\n \"allow_high_risk_user_agent\": true\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-3295aef7-38ea-4797-a79d-b1534f483805" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-4e669fa4-6af7-4ad1-ab9d-19382931f709" } ], "id": "0dbcf721-1142-45d1-8847-a82f81bc02d4", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-0dbcf721-1142-45d1-8847-a82f81bc02d4" }, { "name": "Create a Playback Restriction", "id": "1ff2f90c-12d3-4bc6-bb00-2f5ceec39e15", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"referrer\": {\n \"allowed_domains\": [\n \"\",\n \"\"\n ],\n \"allow_no_referrer\": false\n },\n \"user_agent\": {\n \"allow_no_user_agent\": true,\n \"allow_high_risk_user_agent\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/playback-restrictions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "playback-restrictions" ] }, "description": "Create a new Playback Restriction." }, "response": [ { "id": "e44f44bc-7079-47e0-81b6-809a19af7118", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"referrer\": {\n \"allowed_domains\": [\n \"\",\n \"\"\n ],\n \"allow_no_referrer\": false\n },\n \"user_agent\": {\n \"allow_no_user_agent\": true,\n \"allow_high_risk_user_agent\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/video/v1/playback-restrictions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "playback-restrictions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"referrer\": {\n \"allowed_domains\": [\n \"\",\n \"\"\n ],\n \"allow_no_referrer\": false\n },\n \"user_agent\": {\n \"allow_no_user_agent\": true,\n \"allow_high_risk_user_agent\": true\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e44f44bc-7079-47e0-81b6-809a19af7118" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-1ff2f90c-12d3-4bc6-bb00-2f5ceec39e15" }, { "name": "List Playback Restrictions", "id": "15e4de9f-f52a-439a-8d03-a622ed42a6b6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/playback-restrictions?page=1&limit=25", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "playback-restrictions" ], "query": [ { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Number of items to include in the response", "key": "limit", "value": "25" } ] }, "description": "Returns a list of all Playback Restrictions." }, "response": [ { "id": "6d217ff7-78db-4e36-b0e6-07cd62e65a55", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/playback-restrictions?page=1&limit=25", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "playback-restrictions" ], "query": [ { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Number of items to include in the response", "key": "limit", "value": "25" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"referrer\": {\n \"allowed_domains\": [\n \"\",\n \"\"\n ],\n \"allow_no_referrer\": false\n },\n \"user_agent\": {\n \"allow_no_user_agent\": true,\n \"allow_high_risk_user_agent\": true\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"referrer\": {\n \"allowed_domains\": [\n \"\",\n \"\"\n ],\n \"allow_no_referrer\": false\n },\n \"user_agent\": {\n \"allow_no_user_agent\": true,\n \"allow_high_risk_user_agent\": true\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-6d217ff7-78db-4e36-b0e6-07cd62e65a55" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-15e4de9f-f52a-439a-8d03-a622ed42a6b6" } ], "id": "c27e92ea-d035-4f5e-833b-96776a3a4f39", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-c27e92ea-d035-4f5e-833b-96776a3a4f39" }, { "name": "drm-configurations", "item": [ { "name": "{DRM_CONFIGURATION_ID}", "item": [ { "name": "Retrieve a DRM Configuration", "id": "a359c14c-b808-462b-b7de-06675cd3e749", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/drm-configurations/:DRM_CONFIGURATION_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "drm-configurations", ":DRM_CONFIGURATION_ID" ], "variable": [ { "id": "be4d4091-34ed-4aea-9944-bbac0973061a", "key": "DRM_CONFIGURATION_ID", "value": "", "description": "(Required) The DRM Configuration ID." } ] }, "description": "Retrieves a single DRM Configuration." }, "response": [ { "id": "00d07faa-f469-425a-8b33-8c6e2819a7f3", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/drm-configurations/:DRM_CONFIGURATION_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "drm-configurations", ":DRM_CONFIGURATION_ID" ], "variable": [ { "key": "DRM_CONFIGURATION_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-00d07faa-f469-425a-8b33-8c6e2819a7f3" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a359c14c-b808-462b-b7de-06675cd3e749" } ], "id": "f42fb5ee-61f5-45ba-8aa6-ccba5a58e4d1", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f42fb5ee-61f5-45ba-8aa6-ccba5a58e4d1" }, { "name": "List DRM Configurations", "id": "b40d1bb0-77bc-43e4-adcc-faa0c4a91a7c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/video/v1/drm-configurations?page=1&limit=25", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "drm-configurations" ], "query": [ { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Number of items to include in the response", "key": "limit", "value": "25" } ] }, "description": "Returns a list of DRM Configurations" }, "response": [ { "id": "5bfb96b1-b90c-41e8-84bf-131f1acb22a2", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/video/v1/drm-configurations?page=1&limit=25", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "video", "v1", "drm-configurations" ], "query": [ { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Number of items to include in the response", "key": "limit", "value": "25" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-5bfb96b1-b90c-41e8-84bf-131f1acb22a2" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b40d1bb0-77bc-43e4-adcc-faa0c4a91a7c" } ], "id": "1f2fc95b-88a7-4e18-ba45-a7a706d3df31", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-1f2fc95b-88a7-4e18-ba45-a7a706d3df31" } ], "id": "9feb64e1-7744-4d71-b8bc-c3754a20218d", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-9feb64e1-7744-4d71-b8bc-c3754a20218d" } ], "id": "7a763b41-8e2e-4089-a20c-39c9f7ecf8ab", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-7a763b41-8e2e-4089-a20c-39c9f7ecf8ab" }, { "name": "data", "item": [ { "name": "v1", "item": [ { "name": "video-views", "item": [ { "name": "{VIDEO_VIEW_ID}", "item": [ { "name": "Get a Video View", "id": "29602771-373e-471f-baf7-014894e288b7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/video-views/:VIDEO_VIEW_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "video-views", ":VIDEO_VIEW_ID" ], "variable": [ { "id": "6a6436aa-4ab9-4f1e-8ab2-285f5ed7c76b", "key": "VIDEO_VIEW_ID", "value": "", "description": "(Required) ID of the Video View" } ] }, "description": "Returns the details of a video view." }, "response": [ { "id": "0c8b0456-8517-4e5e-9cf5-60f99b4c3206", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/video-views/:VIDEO_VIEW_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "video-views", ":VIDEO_VIEW_ID" ], "variable": [ { "key": "VIDEO_VIEW_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"ad_attempt_count\": \"\",\n \"ad_break_count\": \"\",\n \"ad_break_error_count\": \"\",\n \"ad_break_error_percentage\": \"\",\n \"ad_error_count\": \"\",\n \"ad_error_percentage\": \"\",\n \"ad_exit_before_start_count\": \"\",\n \"ad_exit_before_start_percentage\": \"\",\n \"ad_impression_count\": \"\",\n \"ad_startup_error_count\": \"\",\n \"ad_startup_error_percentage\": \"\",\n \"rendition_change_count\": \"\",\n \"rendition_upshift_count\": \"\",\n \"rendition_downshift_count\": \"\",\n \"asn\": \"\",\n \"asn_name\": \"\",\n \"asset_id\": \"\",\n \"audio_codec\": \"\",\n \"buffering_count\": \"\",\n \"buffering_duration\": \"\",\n \"buffering_rate\": \"\",\n \"cdn\": \"\",\n \"city\": \"\",\n \"client_application_name\": \"\",\n \"client_application_version\": \"\",\n \"continent_code\": \"\",\n \"country_code\": \"\",\n \"country_name\": \"\",\n \"custom_1\": \"\",\n \"custom_10\": \"\",\n \"custom_2\": \"\",\n \"custom_3\": \"\",\n \"custom_4\": \"\",\n \"custom_5\": \"\",\n \"custom_6\": \"\",\n \"custom_7\": \"\",\n \"custom_8\": \"\",\n \"custom_9\": \"\",\n \"environment_id\": \"\",\n \"error_type_id\": \"\",\n \"events\": [\n {\n \"viewer_time\": \"\",\n \"playback_time\": \"\",\n \"name\": \"\",\n \"event_time\": \"\",\n \"details\": {\n \"ipsum_\": 97591939\n }\n },\n {\n \"viewer_time\": \"\",\n \"playback_time\": \"\",\n \"name\": \"\",\n \"event_time\": \"\",\n \"details\": {\n \"veniame87\": 60520823,\n \"pariatur8\": 78129830\n }\n }\n ],\n \"exit_before_video_start\": \"\",\n \"experiment_name\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"isp\": \"\",\n \"latitude\": \"\",\n \"live_stream_id\": \"\",\n \"live_stream_latency\": \"\",\n \"long_rebuffering\": \"\",\n \"long_resume\": \"\",\n \"longitude\": \"\",\n \"metro\": \"\",\n \"mux_api_version\": \"\",\n \"mux_embed\": \"\",\n \"mux_embed_version\": \"\",\n \"mux_viewer_id\": \"\",\n \"page_load_time\": \"\",\n \"page_type\": \"\",\n \"page_url\": \"\",\n \"platform_description\": \"\",\n \"platform_summary\": \"\",\n \"playback_id\": \"\",\n \"playback_score\": \"\",\n \"player_autoplay\": \"\",\n \"player_error_code\": \"\",\n \"player_error_message\": \"\",\n \"player_height\": \"\",\n \"player_instance_id\": \"\",\n \"player_language\": \"\",\n \"player_load_time\": \"\",\n \"player_mux_plugin_name\": \"\",\n \"player_mux_plugin_version\": \"\",\n \"player_name\": \"\",\n \"player_poster\": \"\",\n \"player_preload\": \"\",\n \"player_remote_played\": \"\",\n \"player_software\": \"\",\n \"player_software_version\": \"\",\n \"player_source_domain\": \"\",\n \"player_source_duration\": \"\",\n \"player_source_height\": \"\",\n \"player_source_host_name\": \"\",\n \"player_source_stream_type\": \"\",\n \"player_source_type\": \"\",\n \"player_source_url\": \"\",\n \"player_source_width\": \"\",\n \"player_startup_time\": \"\",\n \"player_version\": \"\",\n \"player_view_count\": \"\",\n \"player_width\": \"\",\n \"preroll_ad_asset_hostname\": \"\",\n \"preroll_ad_tag_hostname\": \"\",\n \"preroll_played\": \"\",\n \"preroll_requested\": \"\",\n \"property_id\": \"\",\n \"quality_score\": \"\",\n \"rebuffer_percentage\": \"\",\n \"rebuffering_score\": \"\",\n \"region\": \"\",\n \"requests_for_first_preroll\": \"\",\n \"session_id\": \"\",\n \"short_time\": \"\",\n \"startup_score\": \"\",\n \"sub_property_id\": \"\",\n \"time_shift_enabled\": \"\",\n \"time_to_first_frame\": \"\",\n \"updated_at\": \"\",\n \"used_captions\": \"\",\n \"used_fullscreen\": \"\",\n \"used_pip\": \"\",\n \"video_affiliate\": \"\",\n \"video_brand\": \"\",\n \"video_cdn_trace\": [\n \"\",\n \"\"\n ],\n \"video_codec\": \"\",\n \"video_content_type\": \"\",\n \"video_creator_id\": \"\",\n \"video_duration\": \"\",\n \"video_dynamic_range_type\": \"\",\n \"video_source_height_initial\": \"\",\n \"video_source_width_initial\": \"\",\n \"video_source_bitrate_initial\": \"\",\n \"video_codec_initial\": \"\",\n \"audio_codec_initial\": \"\",\n \"video_source_fps_initial\": \"\",\n \"video_dynamic_range_type_initial\": \"\",\n \"video_source_fps\": \"\",\n \"video_source_bitrate\": \"\",\n \"video_source_height\": \"\",\n \"video_source_width\": \"\",\n \"video_encoding_variant\": \"\",\n \"video_id\": \"\",\n \"video_language\": \"\",\n \"video_producer\": \"\",\n \"video_series\": \"\",\n \"video_startup_failure\": \"\",\n \"video_startup_preroll_load_time\": \"\",\n \"video_startup_preroll_request_time\": \"\",\n \"video_stream_type\": \"\",\n \"video_title\": \"\",\n \"video_variant_id\": \"\",\n \"video_variant_name\": \"\",\n \"view_average_request_latency\": \"\",\n \"view_average_request_throughput\": \"\",\n \"view_cdn_edge_pop\": \"\",\n \"view_cdn_origin\": \"\",\n \"view_drm_level\": \"\",\n \"view_drm_type\": \"\",\n \"view_dropped\": \"\",\n \"view_dropped_frame_count\": \"\",\n \"view_end\": \"\",\n \"view_error_id\": \"\",\n \"view_has_ad\": \"\",\n \"view_id\": \"\",\n \"view_max_downscale_percentage\": \"\",\n \"view_max_playhead_position\": \"\",\n \"view_max_request_latency\": \"\",\n \"view_max_upscale_percentage\": \"\",\n \"view_playing_time\": \"\",\n \"view_seek_count\": \"\",\n \"view_seek_duration\": \"\",\n \"view_session_id\": \"\",\n \"view_start\": \"\",\n \"view_total_content_playback_time\": \"\",\n \"view_total_downscaling\": \"\",\n \"view_total_upscaling\": \"\",\n \"viewer_application_engine\": \"\",\n \"viewer_application_name\": \"\",\n \"viewer_application_version\": \"\",\n \"viewer_connection_type\": \"\",\n \"viewer_device_category\": \"\",\n \"viewer_device_manufacturer\": \"\",\n \"viewer_device_model\": \"\",\n \"viewer_device_name\": \"\",\n \"viewer_experience_score\": \"\",\n \"viewer_os_architecture\": \"\",\n \"viewer_os_family\": \"\",\n \"viewer_os_version\": \"\",\n \"viewer_plan\": \"\",\n \"viewer_plan_status\": \"\",\n \"viewer_plan_category\": \"\",\n \"viewer_user_agent\": \"\",\n \"viewer_user_id\": \"\",\n \"watch_time\": \"\",\n \"watched\": \"\",\n \"weighted_average_bitrate\": \"\",\n \"playback_failure_error_type_id\": \"\",\n \"playback_business_exception_error_type_id\": \"\",\n \"video_startup_business_exception_error_type_id\": \"\",\n \"playback_failure\": \"\",\n \"ad_playback_failure_error_type_id\": \"\",\n \"view_content_startup_time\": \"\",\n \"ad_preroll_startup_time\": \"\",\n \"player_error_context\": \"\"\n },\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-0c8b0456-8517-4e5e-9cf5-60f99b4c3206" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-29602771-373e-471f-baf7-014894e288b7" } ], "id": "5557c6c6-7d86-44d5-9726-c7e57aa7a6ac", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-5557c6c6-7d86-44d5-9726-c7e57aa7a6ac" }, { "name": "List Video Views", "id": "81c74e67-ae55-4a91-b14c-2619adbf5df2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/video-views?limit=25&page=1&viewer_id=&error_id=&order_direction=asc&filters[]=&filters[]=&metric_filters[]=&metric_filters[]=&timeframe[]=&timeframe[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "video-views" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Viewer ID to filter results by. This value may be provided by the integration, or may be created by Mux.", "key": "viewer_id", "value": "" }, { "description": "Filter video views by the provided error ID (as returned in the error_type_id field in the list video views endpoint). If you provide any as the error ID, this will filter the results to those with any error.", "key": "error_id", "value": "" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" } ] }, "description": "Returns a list of video views which match the filters and have a `view_end` within the specified timeframe." }, "response": [ { "id": "5b87bf93-1014-44c5-b9f5-3c0c0934a66d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/video-views?limit=25&page=1&viewer_id=&error_id=&order_direction=asc&filters[]=&metric_filters[]=&timeframe[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "video-views" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Viewer ID to filter results by. This value may be provided by the integration, or may be created by Mux.", "key": "viewer_id", "value": "" }, { "description": "Filter video views by the provided error ID (as returned in the error_type_id field in the list video views endpoint). If you provide any as the error ID, this will filter the results to those with any error.", "key": "error_id", "value": "" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"viewer_os_family\": \"\",\n \"viewer_application_name\": \"\",\n \"video_title\": \"\",\n \"total_row_count\": \"\",\n \"player_error_message\": \"\",\n \"player_error_code\": \"\",\n \"error_type_id\": \"\",\n \"country_code\": \"\",\n \"view_start\": \"\",\n \"view_end\": \"\",\n \"viewer_experience_score\": \"\",\n \"watch_time\": \"\",\n \"playback_failure\": \"\"\n },\n {\n \"id\": \"\",\n \"viewer_os_family\": \"\",\n \"viewer_application_name\": \"\",\n \"video_title\": \"\",\n \"total_row_count\": \"\",\n \"player_error_message\": \"\",\n \"player_error_code\": \"\",\n \"error_type_id\": \"\",\n \"country_code\": \"\",\n \"view_start\": \"\",\n \"view_end\": \"\",\n \"viewer_experience_score\": \"\",\n \"watch_time\": \"\",\n \"playback_failure\": \"\"\n }\n ],\n \"total_row_count\": \"\",\n \"timeframe\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-5b87bf93-1014-44c5-b9f5-3c0c0934a66d" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-81c74e67-ae55-4a91-b14c-2619adbf5df2" } ], "id": "fb2ac2e7-d58b-4498-b6f1-8c49f3bb22eb", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-fb2ac2e7-d58b-4498-b6f1-8c49f3bb22eb" }, { "name": "errors", "item": [ { "name": "List Errors", "id": "7f5e4b8d-34f2-4cad-8dc0-59a416ce223d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/errors?filters[]=&filters[]=&metric_filters[]=&metric_filters[]=&timeframe[]=&timeframe[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "errors" ], "query": [ { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" } ] }, "description": "Returns a list of errors." }, "response": [ { "id": "f773ae0c-27bd-4311-bf75-e122fbd5adda", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/errors?filters[]=&metric_filters[]=&timeframe[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "errors" ], "query": [ { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"percentage\": \"\",\n \"notes\": \"\",\n \"message\": \"\",\n \"last_seen\": \"\",\n \"description\": \"\",\n \"count\": \"\",\n \"code\": \"\",\n \"player_error_code\": \"\"\n },\n {\n \"id\": \"\",\n \"percentage\": \"\",\n \"notes\": \"\",\n \"message\": \"\",\n \"last_seen\": \"\",\n \"description\": \"\",\n \"count\": \"\",\n \"code\": \"\",\n \"player_error_code\": \"\"\n }\n ],\n \"total_row_count\": \"\",\n \"timeframe\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f773ae0c-27bd-4311-bf75-e122fbd5adda" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-7f5e4b8d-34f2-4cad-8dc0-59a416ce223d" } ], "id": "bf9134b0-84d8-42fe-b48f-c2ec83571731", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-bf9134b0-84d8-42fe-b48f-c2ec83571731" }, { "name": "filters", "item": [ { "name": "{FILTER_ID}", "item": [ { "name": "Lists Values for a Specific Filter", "id": "38412e09-e907-4eb5-858e-b1e8eb68f261", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/filters/:FILTER_ID?limit=25&page=1&filters[]=&filters[]=&timeframe[]=&timeframe[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "filters", ":FILTER_ID" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" } ], "variable": [ { "id": "a4b805cb-7aaf-4890-810f-5eb14c3ad4c3", "key": "FILTER_ID", "value": "", "description": "(Required) ID of the Filter" } ] }, "description": "The API has been replaced by the list-dimension-values API call.\n\nLists the values for a filter along with a total count of related views.\n" }, "response": [ { "id": "3445efe6-ff3c-4da2-b6a3-1d3c0d0a56cb", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/filters/:FILTER_ID?limit=25&page=1&filters[]=&timeframe[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "filters", ":FILTER_ID" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" } ], "variable": [ { "key": "FILTER_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"value\": \"\",\n \"total_count\": \"\"\n },\n {\n \"value\": \"\",\n \"total_count\": \"\"\n }\n ],\n \"total_row_count\": \"\",\n \"timeframe\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-3445efe6-ff3c-4da2-b6a3-1d3c0d0a56cb" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-38412e09-e907-4eb5-858e-b1e8eb68f261" } ], "id": "b9f4bb09-a27c-4eb1-b028-48d189b74b04", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b9f4bb09-a27c-4eb1-b028-48d189b74b04" }, { "name": "List Filters", "id": "01c967cf-4bb8-4e1b-a356-4562ba3b9200", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/filters", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "filters" ] }, "description": "The API has been replaced by the list-dimensions API call.\n\nLists all the filters broken out into basic and advanced.\n" }, "response": [ { "id": "483f5555-9bf8-47cf-afa9-e016414a4cf8", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/filters", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "filters" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"basic\": [\n \"\",\n \"\"\n ],\n \"advanced\": [\n \"\",\n \"\"\n ]\n },\n \"total_row_count\": \"\",\n \"timeframe\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-483f5555-9bf8-47cf-afa9-e016414a4cf8" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-01c967cf-4bb8-4e1b-a356-4562ba3b9200" } ], "id": "773f9732-9949-483d-9407-dc45a3f4a5c2", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-773f9732-9949-483d-9407-dc45a3f4a5c2" }, { "name": "dimensions", "item": [ { "name": "{DIMENSION_ID}", "item": [ { "name": "elements", "item": [ { "name": "Lists Elements for a Trace Dimension", "id": "736263b8-9499-497f-8200-b67cca4aea3b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/dimensions/:DIMENSION_ID/elements?limit=25&page=1&filters[]=&filters[]=&metric_filters[]=&metric_filters[]=&timeframe[]=&timeframe[]=&order_by=field&order_direction=asc", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "dimensions", ":DIMENSION_ID", "elements" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Value to order the results by", "key": "order_by", "value": "field" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" } ], "variable": [ { "id": "f1b00cc2-d043-4791-bf1b-5d14e28b6c03", "key": "DIMENSION_ID", "value": "", "description": "(Required) ID of the Dimension" } ] }, "description": "Lists the elements (values) for a trace dimension along with their total counts.\nThis endpoint is specifically designed for trace dimensions like video_cdn_trace\nthat contain arrays of values.\n" }, "response": [ { "id": "b0087df9-76d3-46a9-947f-8389413b4678", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/dimensions/:DIMENSION_ID/elements?limit=25&page=1&filters[]=&metric_filters[]=&timeframe[]=&order_by=field&order_direction=asc", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "dimensions", ":DIMENSION_ID", "elements" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Value to order the results by", "key": "order_by", "value": "field" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" } ], "variable": [ { "key": "DIMENSION_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"value\": \"\",\n \"total_count\": \"\"\n },\n {\n \"value\": \"\",\n \"total_count\": \"\"\n }\n ],\n \"total_row_count\": \"\",\n \"timeframe\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b0087df9-76d3-46a9-947f-8389413b4678" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-736263b8-9499-497f-8200-b67cca4aea3b" } ], "id": "dfa98ce0-5392-40bc-a753-da30ff21b1f2", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-dfa98ce0-5392-40bc-a753-da30ff21b1f2" }, { "name": "Lists the Values for a Specific Dimension", "id": "adb74589-03a4-4568-afab-76c99593d1e7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/dimensions/:DIMENSION_ID?limit=25&page=1&filters[]=&filters[]=&metric_filters[]=&metric_filters[]=&timeframe[]=&timeframe[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "dimensions", ":DIMENSION_ID" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" } ], "variable": [ { "id": "64a870bc-0b5a-42eb-8735-8f9521c2d1fa", "key": "DIMENSION_ID", "value": "", "description": "(Required) ID of the Dimension" } ] }, "description": "Lists the values for a dimension along with a total count of related views.\n\nNote: This API replaces the list-filter-values API call.\n" }, "response": [ { "id": "f2589309-9dc5-461d-941a-7a56987fbd16", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/dimensions/:DIMENSION_ID?limit=25&page=1&filters[]=&metric_filters[]=&timeframe[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "dimensions", ":DIMENSION_ID" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" } ], "variable": [ { "key": "DIMENSION_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"value\": \"\",\n \"total_count\": \"\"\n },\n {\n \"value\": \"\",\n \"total_count\": \"\"\n }\n ],\n \"total_row_count\": \"\",\n \"timeframe\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f2589309-9dc5-461d-941a-7a56987fbd16" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-adb74589-03a4-4568-afab-76c99593d1e7" } ], "id": "f61d6fed-6463-4b0d-97c1-31cae0b7ba4a", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f61d6fed-6463-4b0d-97c1-31cae0b7ba4a" }, { "name": "List Dimensions", "id": "77a63e07-477c-4c2e-9f00-9abaeb6b5e0e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/dimensions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "dimensions" ] }, "description": "List all available dimensions.\n\nNote: This API replaces the list-filters API call.\n" }, "response": [ { "id": "d92b3787-db53-441c-91e8-afbec58d2a94", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/dimensions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "dimensions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"basic\": [\n \"\",\n \"\"\n ],\n \"advanced\": [\n \"\",\n \"\"\n ]\n },\n \"total_row_count\": \"\",\n \"timeframe\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-d92b3787-db53-441c-91e8-afbec58d2a94" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-77a63e07-477c-4c2e-9f00-9abaeb6b5e0e" } ], "id": "55a137ab-4dec-4778-8172-4b5d1bbe2af5", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-55a137ab-4dec-4778-8172-4b5d1bbe2af5" }, { "name": "exports", "item": [ { "name": "views", "item": [ { "name": "List Available Property View Exports", "id": "035fb9d5-da05-4647-a070-a8c711c7c93a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/exports/views", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "exports", "views" ] }, "description": "Lists the available video view exports along with URLs to retrieve them." }, "response": [ { "id": "d99e3e30-e6ca-4615-86b0-0c10041cfc85", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/exports/views", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "exports", "views" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"export_date\": \"\",\n \"files\": [\n {\n \"version\": \"\",\n \"type\": \"\",\n \"path\": \"\"\n },\n {\n \"version\": \"\",\n \"type\": \"\",\n \"path\": \"\"\n }\n ]\n },\n {\n \"export_date\": \"\",\n \"files\": [\n {\n \"version\": \"\",\n \"type\": \"\",\n \"path\": \"\"\n },\n {\n \"version\": \"\",\n \"type\": \"\",\n \"path\": \"\"\n }\n ]\n }\n ],\n \"total_row_count\": \"\",\n \"timeframe\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-d99e3e30-e6ca-4615-86b0-0c10041cfc85" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-035fb9d5-da05-4647-a070-a8c711c7c93a" } ], "id": "da530240-3d7a-43f7-a887-92b961b8cea9", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-da530240-3d7a-43f7-a887-92b961b8cea9" }, { "name": "List Property Video View Export Links", "id": "1cf161f3-7b84-4288-a769-779c19a05388", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/exports", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "exports" ] }, "description": "The API has been replaced by the list-exports-views API call.\n\nLists the available video view exports along with URLs to retrieve them.\n" }, "response": [ { "id": "2e683070-9dfe-4c94-b15e-3b5444f45f53", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/exports", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "exports" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\",\n \"timeframe\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-2e683070-9dfe-4c94-b15e-3b5444f45f53" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-1cf161f3-7b84-4288-a769-779c19a05388" } ], "id": "27031d8a-a074-4ba1-95ac-92f361484f5b", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-27031d8a-a074-4ba1-95ac-92f361484f5b" }, { "name": "metrics", "item": [ { "name": "{METRIC_ID}", "item": [ { "name": "breakdown", "item": [ { "name": "List Breakdown Values", "id": "03b4decb-260c-401a-9f6c-d56d5e206d1c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/metrics/:METRIC_ID/breakdown?group_by=custom_2&measurement=avg&filters[]=&filters[]=&metric_filters[]=&metric_filters[]=&limit=25&page=1&order_by=field&order_direction=asc&timeframe[]=&timeframe[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "metrics", ":METRIC_ID", "breakdown" ], "query": [ { "description": "Breakdown value to group the results by", "key": "group_by", "value": "custom_2" }, { "description": "Measurement for the provided metric. If omitted, the default for the metric will be used.\nThe default measurement for each metric is:\n\"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time`\n\"median\" : `ad_preroll_startup_time`, `aggregate_startup_time`, `content_startup_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate`\n\"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `view_dropped_percentage`, `viewer_experience_score`\n\"count\" : `started_views`, `unique_viewers`\n", "key": "measurement", "value": "avg" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Value to order the results by", "key": "order_by", "value": "field" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" } ], "variable": [ { "id": "ace41936-b957-4cf9-9f0c-4b56a47bed02", "key": "METRIC_ID", "value": "upscale_percentage", "description": "(Required) ID of the Metric" } ] }, "description": "List the breakdown values for a specific metric." }, "response": [ { "id": "1fb9fa98-ca49-4ac4-bf16-3854d86a004e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/metrics/:METRIC_ID/breakdown?group_by=custom_2&measurement=avg&filters[]=&metric_filters[]=&limit=25&page=1&order_by=field&order_direction=asc&timeframe[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "metrics", ":METRIC_ID", "breakdown" ], "query": [ { "description": "Breakdown value to group the results by", "key": "group_by", "value": "custom_2" }, { "description": "Measurement for the provided metric. If omitted, the default for the metric will be used.\nThe default measurement for each metric is:\n\"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time`\n\"median\" : `ad_preroll_startup_time`, `aggregate_startup_time`, `content_startup_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate`\n\"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `view_dropped_percentage`, `viewer_experience_score`\n\"count\" : `started_views`, `unique_viewers`\n", "key": "measurement", "value": "avg" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Value to order the results by", "key": "order_by", "value": "field" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" } ], "variable": [ { "key": "METRIC_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"views\": \"\",\n \"negative_impact\": \"\",\n \"total_watch_time\": \"\",\n \"total_playing_time\": \"\"\n },\n {\n \"field\": \"\",\n \"value\": \"\",\n \"views\": \"\",\n \"negative_impact\": \"\",\n \"total_watch_time\": \"\",\n \"total_playing_time\": \"\"\n }\n ],\n \"total_row_count\": \"\",\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"meta\": {\n \"granularity\": \"\",\n \"aggregation\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-1fb9fa98-ca49-4ac4-bf16-3854d86a004e" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-03b4decb-260c-401a-9f6c-d56d5e206d1c" } ], "id": "76e339ad-06df-40cf-88bb-361a7bab656f", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-76e339ad-06df-40cf-88bb-361a7bab656f" }, { "name": "overall", "item": [ { "name": "Get Overall Values", "id": "28e1c0ee-041b-49f0-9f60-d47a47f8b34a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/metrics/:METRIC_ID/overall?timeframe[]=&timeframe[]=&filters[]=&filters[]=&metric_filters[]=&metric_filters[]=&measurement=avg", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "metrics", ":METRIC_ID", "overall" ], "query": [ { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Measurement for the provided metric. If omitted, the default for the metric will be used.\nThe default measurement for each metric is:\n\"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time`\n\"median\" : `ad_preroll_startup_time`, `aggregate_startup_time`, `content_startup_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate`\n\"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `view_dropped_percentage`, `viewer_experience_score`\n\"count\" : `started_views`, `unique_viewers`\n", "key": "measurement", "value": "avg" } ], "variable": [ { "id": "2c237dac-022d-4306-bf1b-a14da8c71c00", "key": "METRIC_ID", "value": "upscale_percentage", "description": "(Required) ID of the Metric" } ] }, "description": "Returns the overall value for a specific metric, as well as the total view count, watch time, and the Mux Global metric value for the metric." }, "response": [ { "id": "11b942d3-a1be-407a-8d1a-27e6791deedd", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/metrics/:METRIC_ID/overall?timeframe[]=&filters[]=&metric_filters[]=&measurement=avg", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "metrics", ":METRIC_ID", "overall" ], "query": [ { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Measurement for the provided metric. If omitted, the default for the metric will be used.\nThe default measurement for each metric is:\n\"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time`\n\"median\" : `ad_preroll_startup_time`, `aggregate_startup_time`, `content_startup_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate`\n\"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `view_dropped_percentage`, `viewer_experience_score`\n\"count\" : `started_views`, `unique_viewers`\n", "key": "measurement", "value": "avg" } ], "variable": [ { "key": "METRIC_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"value\": \"\",\n \"total_watch_time\": \"\",\n \"total_views\": \"\",\n \"total_playing_time\": \"\",\n \"global_value\": \"\"\n },\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\",\n \"meta\": {\n \"granularity\": \"\",\n \"aggregation\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-11b942d3-a1be-407a-8d1a-27e6791deedd" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-28e1c0ee-041b-49f0-9f60-d47a47f8b34a" } ], "id": "55df7aad-4b66-4803-9578-012d9eb9e356", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-55df7aad-4b66-4803-9578-012d9eb9e356" }, { "name": "insights", "item": [ { "name": "List Insights", "id": "29fd8c18-c370-4a5d-a8d6-9e9f37551088", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/metrics/:METRIC_ID/insights?measurement=avg&order_direction=asc&timeframe[]=&timeframe[]=&filters[]=&filters[]=&metric_filters[]=&metric_filters[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "metrics", ":METRIC_ID", "insights" ], "query": [ { "description": "Measurement for the provided metric. If omitted, the default for the metric will be used.\nThe default measurement for each metric is:\n\"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time`\n\"median\" : `ad_preroll_startup_time`, `aggregate_startup_time`, `content_startup_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate`\n\"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `view_dropped_percentage`, `viewer_experience_score`\n\"count\" : `started_views`, `unique_viewers`\n", "key": "measurement", "value": "avg" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" } ], "variable": [ { "id": "f5213db5-85fe-480a-b161-9aa4e4fc818e", "key": "METRIC_ID", "value": "upscale_percentage", "description": "(Required) ID of the Metric" } ] }, "description": "Returns a list of insights for a metric. These are the worst performing values across all breakdowns sorted by how much they negatively impact a specific metric." }, "response": [ { "id": "c4278115-61c6-4ada-92b8-7daa008ffdbc", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/metrics/:METRIC_ID/insights?measurement=avg&order_direction=asc&timeframe[]=&filters[]=&metric_filters[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "metrics", ":METRIC_ID", "insights" ], "query": [ { "description": "Measurement for the provided metric. If omitted, the default for the metric will be used.\nThe default measurement for each metric is:\n\"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time`\n\"median\" : `ad_preroll_startup_time`, `aggregate_startup_time`, `content_startup_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate`\n\"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `view_dropped_percentage`, `viewer_experience_score`\n\"count\" : `started_views`, `unique_viewers`\n", "key": "measurement", "value": "avg" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" } ], "variable": [ { "key": "METRIC_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"total_watch_time\": \"\",\n \"total_playing_time\": \"\",\n \"total_views\": \"\",\n \"negative_impact_score\": \"\",\n \"metric\": \"\",\n \"filter_value\": \"\",\n \"filter_column\": \"\"\n },\n {\n \"total_watch_time\": \"\",\n \"total_playing_time\": \"\",\n \"total_views\": \"\",\n \"negative_impact_score\": \"\",\n \"metric\": \"\",\n \"filter_value\": \"\",\n \"filter_column\": \"\"\n }\n ],\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\",\n \"meta\": {\n \"granularity\": \"\",\n \"aggregation\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-c4278115-61c6-4ada-92b8-7daa008ffdbc" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-29fd8c18-c370-4a5d-a8d6-9e9f37551088" } ], "id": "8609321e-0200-48ca-8dd9-daae9a3450e4", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-8609321e-0200-48ca-8dd9-daae9a3450e4" }, { "name": "timeseries", "item": [ { "name": "Get Metric Timeseries Data", "id": "6f5f3047-54ec-47f9-bf1f-4e6a4a69f19a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/metrics/:METRIC_ID/timeseries?timeframe[]=&timeframe[]=&filters[]=&filters[]=&metric_filters[]=&metric_filters[]=&measurement=avg&order_direction=asc&group_by=day", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "metrics", ":METRIC_ID", "timeseries" ], "query": [ { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Measurement for the provided metric. If omitted, the default for the metric will be used.\nThe default measurement for each metric is:\n\"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time`\n\"median\" : `ad_preroll_startup_time`, `aggregate_startup_time`, `content_startup_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate`\n\"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `view_dropped_percentage`, `viewer_experience_score`\n\"count\" : `started_views`, `unique_viewers`\n", "key": "measurement", "value": "avg" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" }, { "description": "Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe.\n\nFor timeframes of less than 90 minutes, the default granularity is `minute`. Between 90 minutes and 6 hours, the default granularity is `ten_minutes`. Between 6 hours and 15 days inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 days is `day`. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.\n", "key": "group_by", "value": "day" } ], "variable": [ { "id": "0c2fddd9-6558-4496-8dd3-3c4b8a095f0c", "key": "METRIC_ID", "value": "upscale_percentage", "description": "(Required) ID of the Metric" } ] }, "description": "Returns timeseries data for a specific metric.\n\nEach interval represented in the data array contains an array with the following values:\n * the first element is the interval time\n * the second element is the calculated metric value\n * the third element is the number of views in the interval that have a valid metric value\n" }, "response": [ { "id": "aede0c94-0598-4c66-b1d7-42a8e29097f9", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/metrics/:METRIC_ID/timeseries?timeframe[]=&filters[]=&metric_filters[]=&measurement=avg&order_direction=asc&group_by=day", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "metrics", ":METRIC_ID", "timeseries" ], "query": [ { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Measurement for the provided metric. If omitted, the default for the metric will be used.\nThe default measurement for each metric is:\n\"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time`\n\"median\" : `ad_preroll_startup_time`, `aggregate_startup_time`, `content_startup_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate`\n\"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `view_dropped_percentage`, `viewer_experience_score`\n\"count\" : `started_views`, `unique_viewers`\n", "key": "measurement", "value": "avg" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" }, { "description": "Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe.\n\nFor timeframes of less than 90 minutes, the default granularity is `minute`. Between 90 minutes and 6 hours, the default granularity is `ten_minutes`. Between 6 hours and 15 days inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 days is `day`. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.\n", "key": "group_by", "value": "day" } ], "variable": [ { "key": "METRIC_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\",\n \"meta\": {\n \"granularity\": \"\",\n \"aggregation\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-aede0c94-0598-4c66-b1d7-42a8e29097f9" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-6f5f3047-54ec-47f9-bf1f-4e6a4a69f19a" } ], "id": "1fe289c0-1d8b-4756-b4d1-8ca8cd06c36a", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-1fe289c0-1d8b-4756-b4d1-8ca8cd06c36a" } ], "id": "decb2dfb-bc2a-444c-a069-6ebb788e35a0", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-decb2dfb-bc2a-444c-a069-6ebb788e35a0" }, { "name": "comparison", "item": [ { "name": "List All Metric Values", "id": "ac906dc0-7df8-4a51-ae1e-1561c222dbd5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/metrics/comparison?timeframe[]=&timeframe[]=&filters[]=&filters[]=&metric_filters[]=&metric_filters[]=&dimension=player_preload&value=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "metrics", "comparison" ], "query": [ { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Dimension the specified value belongs to", "key": "dimension", "value": "player_preload" }, { "description": "Value to show all available metrics for", "key": "value", "value": "" } ] }, "description": "List all of the values across every breakdown for a specific metric." }, "response": [ { "id": "0695cb95-46aa-4949-a936-08266b65abc5", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/metrics/comparison?timeframe[]=&filters[]=&metric_filters[]=&dimension=player_preload&value=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "metrics", "comparison" ], "query": [ { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n", "key": "metric_filters[]", "value": "" }, { "description": "Dimension the specified value belongs to", "key": "dimension", "value": "player_preload" }, { "description": "Value to show all available metrics for", "key": "value", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"name\": \"\",\n \"watch_time\": \"\",\n \"view_count\": \"\",\n \"unique_viewers\": \"\",\n \"started_views\": \"\",\n \"total_playing_time\": \"\",\n \"ended_views\": \"\",\n \"value\": \"\",\n \"type\": \"\",\n \"metric\": \"\",\n \"items\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"\",\n \"metric\": \"\",\n \"measurement\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"\",\n \"metric\": \"\",\n \"measurement\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"watch_time\": \"\",\n \"view_count\": \"\",\n \"unique_viewers\": \"\",\n \"started_views\": \"\",\n \"total_playing_time\": \"\",\n \"ended_views\": \"\",\n \"value\": \"\",\n \"type\": \"\",\n \"metric\": \"\",\n \"items\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"\",\n \"metric\": \"\",\n \"measurement\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"\",\n \"metric\": \"\",\n \"measurement\": \"\"\n }\n ]\n }\n ],\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-0695cb95-46aa-4949-a936-08266b65abc5" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-ac906dc0-7df8-4a51-ae1e-1561c222dbd5" } ], "id": "d71407bb-ccc7-4d2b-a4ba-e25355f5e297", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-d71407bb-ccc7-4d2b-a4ba-e25355f5e297" } ], "id": "a2eaab79-f37f-4d31-ad44-92f1de970b67", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a2eaab79-f37f-4d31-ad44-92f1de970b67" }, { "name": "monitoring", "item": [ { "name": "dimensions", "item": [ { "name": "List Monitoring Dimensions", "id": "f851d032-4b72-4dc6-a5fa-db587ed235c4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/monitoring/dimensions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "monitoring", "dimensions" ] }, "description": "Lists available monitoring dimensions." }, "response": [ { "id": "1cce50c5-a727-4e1e-a3bf-b9824eba1a99", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/monitoring/dimensions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "monitoring", "dimensions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"name\": \"\",\n \"display_name\": \"\"\n },\n {\n \"name\": \"\",\n \"display_name\": \"\"\n }\n ],\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-1cce50c5-a727-4e1e-a3bf-b9824eba1a99" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f851d032-4b72-4dc6-a5fa-db587ed235c4" } ], "id": "6db46004-3a42-46ba-9dae-33d5939d474d", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-6db46004-3a42-46ba-9dae-33d5939d474d" }, { "name": "metrics", "item": [ { "name": "{MONITORING_METRIC_ID}", "item": [ { "name": "breakdown", "item": [ { "name": "Get Monitoring Breakdown", "id": "f2394c32-04f4-4c1d-bfa4-b9b31707806a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/monitoring/metrics/:MONITORING_METRIC_ID/breakdown?dimension=cdn×tamp=&filters[]=&filters[]=&order_by=field&order_direction=asc", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "monitoring", "metrics", ":MONITORING_METRIC_ID", "breakdown" ], "query": [ { "description": "Dimension the specified value belongs to", "key": "dimension", "value": "cdn" }, { "description": "Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.", "key": "timestamp", "value": "" }, { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" }, { "description": "Value to order the results by", "key": "order_by", "value": "field" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" } ], "variable": [ { "id": "dac6902f-cad4-4bb4-83bf-ad4d284d7fff", "key": "MONITORING_METRIC_ID", "value": "playback-failure-percentage", "description": "(Required) ID of the Monitoring Metric" } ] }, "description": "Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score." }, "response": [ { "id": "b7976962-06c8-4995-9a93-67757ca98dcc", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/monitoring/metrics/:MONITORING_METRIC_ID/breakdown?dimension=cdn×tamp=&filters[]=&order_by=field&order_direction=asc", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "monitoring", "metrics", ":MONITORING_METRIC_ID", "breakdown" ], "query": [ { "description": "Dimension the specified value belongs to", "key": "dimension", "value": "cdn" }, { "description": "Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.", "key": "timestamp", "value": "" }, { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" }, { "description": "Value to order the results by", "key": "order_by", "value": "field" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" } ], "variable": [ { "key": "MONITORING_METRIC_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"value\": \"\",\n \"negative_impact\": \"\",\n \"metric_value\": \"\",\n \"concurrent_viewers\": \"\",\n \"starting_up_viewers\": \"\",\n \"display_value\": \"\"\n },\n {\n \"value\": \"\",\n \"negative_impact\": \"\",\n \"metric_value\": \"\",\n \"concurrent_viewers\": \"\",\n \"starting_up_viewers\": \"\",\n \"display_value\": \"\"\n }\n ],\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b7976962-06c8-4995-9a93-67757ca98dcc" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f2394c32-04f4-4c1d-bfa4-b9b31707806a" } ], "id": "a1e51065-eb80-4a16-a4ca-f2f63b6be21c", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a1e51065-eb80-4a16-a4ca-f2f63b6be21c" }, { "name": "breakdown-timeseries", "item": [ { "name": "Get Monitoring Breakdown Timeseries", "id": "ce14bbe4-7e29-4295-990b-e9f71510544a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/monitoring/metrics/:MONITORING_METRIC_ID/breakdown-timeseries?dimension=cdn&timeframe[]=&timeframe[]=&filters[]=&filters[]=&limit=10&order_by=field&order_direction=asc", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "monitoring", "metrics", ":MONITORING_METRIC_ID", "breakdown-timeseries" ], "query": [ { "description": "Dimension the specified value belongs to", "key": "dimension", "value": "cdn" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nThe default for this is the last 60 seconds of available data. Timeframes larger than 10 minutes are not allowed, and must be within the last 24 hours.\n", "key": "timeframe[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nThe default for this is the last 60 seconds of available data. Timeframes larger than 10 minutes are not allowed, and must be within the last 24 hours.\n", "key": "timeframe[]", "value": "" }, { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" }, { "description": "Number of items to include in each timestamp's `value` list.\n\nThe default is 10, and the maximum is 100.\n", "key": "limit", "value": "10" }, { "description": "Value to order the results by", "key": "order_by", "value": "field" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" } ], "variable": [ { "id": "9beeca6d-6277-47c2-a457-c324d13b1afa", "key": "MONITORING_METRIC_ID", "value": "playback-failure-percentage", "description": "(Required) ID of the Monitoring Metric" } ] }, "description": "Gets timeseries of breakdown information for a specific dimension and metric. Each datapoint in the response represents 5 seconds worth of data." }, "response": [ { "id": "45012bde-45ed-4c6a-94dd-4e225d14050d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/monitoring/metrics/:MONITORING_METRIC_ID/breakdown-timeseries?dimension=cdn&timeframe[]=&filters[]=&limit=10&order_by=field&order_direction=asc", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "monitoring", "metrics", ":MONITORING_METRIC_ID", "breakdown-timeseries" ], "query": [ { "description": "Dimension the specified value belongs to", "key": "dimension", "value": "cdn" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nThe default for this is the last 60 seconds of available data. Timeframes larger than 10 minutes are not allowed, and must be within the last 24 hours.\n", "key": "timeframe[]", "value": "" }, { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" }, { "description": "Number of items to include in each timestamp's `value` list.\n\nThe default is 10, and the maximum is 100.\n", "key": "limit", "value": "10" }, { "description": "Value to order the results by", "key": "order_by", "value": "field" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" } ], "variable": [ { "key": "MONITORING_METRIC_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"values\": [\n {\n \"value\": \"\",\n \"metric_value\": \"\",\n \"concurrent_viewers\": \"\",\n \"starting_up_viewers\": \"\"\n },\n {\n \"value\": \"\",\n \"metric_value\": \"\",\n \"concurrent_viewers\": \"\",\n \"starting_up_viewers\": \"\"\n }\n ],\n \"date\": \"\"\n },\n {\n \"values\": [\n {\n \"value\": \"\",\n \"metric_value\": \"\",\n \"concurrent_viewers\": \"\",\n \"starting_up_viewers\": \"\"\n },\n {\n \"value\": \"\",\n \"metric_value\": \"\",\n \"concurrent_viewers\": \"\",\n \"starting_up_viewers\": \"\"\n }\n ],\n \"date\": \"\"\n }\n ],\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-45012bde-45ed-4c6a-94dd-4e225d14050d" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-ce14bbe4-7e29-4295-990b-e9f71510544a" } ], "id": "caa28e11-39db-4a2a-a93c-c212eaefbf95", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-caa28e11-39db-4a2a-a93c-c212eaefbf95" }, { "name": "timeseries", "item": [ { "name": "Get Monitoring Timeseries", "id": "bfc6e79d-cdbe-43e9-b628-739c9599c233", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/monitoring/metrics/:MONITORING_METRIC_ID/timeseries?filters[]=&filters[]=×tamp=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "monitoring", "metrics", ":MONITORING_METRIC_ID", "timeseries" ], "query": [ { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" }, { "description": "Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago.", "key": "timestamp", "value": "" } ], "variable": [ { "id": "3b6f7382-ddb9-426e-81fe-9f245eea19ac", "key": "MONITORING_METRIC_ID", "value": "playback-failure-percentage", "description": "(Required) ID of the Monitoring Metric" } ] }, "description": "Gets Time series information for a specific metric along with the number of concurrent viewers." }, "response": [ { "id": "44f61c35-12ed-4de7-a28c-f060c031ef37", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/monitoring/metrics/:MONITORING_METRIC_ID/timeseries?filters[]=×tamp=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "monitoring", "metrics", ":MONITORING_METRIC_ID", "timeseries" ], "query": [ { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" }, { "description": "Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago.", "key": "timestamp", "value": "" } ], "variable": [ { "key": "MONITORING_METRIC_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"value\": \"\",\n \"date\": \"\",\n \"concurrent_viewers\": \"\"\n },\n {\n \"value\": \"\",\n \"date\": \"\",\n \"concurrent_viewers\": \"\"\n }\n ],\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-44f61c35-12ed-4de7-a28c-f060c031ef37" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-bfc6e79d-cdbe-43e9-b628-739c9599c233" } ], "id": "062ca3e4-4576-41dd-8e03-6e52569dad43", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-062ca3e4-4576-41dd-8e03-6e52569dad43" } ], "id": "6496c2a0-5102-45f9-ae13-3e24605f679f", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-6496c2a0-5102-45f9-ae13-3e24605f679f" }, { "name": "{MONITORING_HISTOGRAM_METRIC_ID}", "item": [ { "name": "histogram-timeseries", "item": [ { "name": "Get Monitoring Histogram Timeseries", "id": "5071595c-1797-4403-9954-5c502b89f37c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/monitoring/metrics/:MONITORING_HISTOGRAM_METRIC_ID/histogram-timeseries?filters[]=&filters[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "monitoring", "metrics", ":MONITORING_HISTOGRAM_METRIC_ID", "histogram-timeseries" ], "query": [ { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" } ], "variable": [ { "id": "150a27f1-bf9f-43a4-9cf7-5f7e47311402", "key": "MONITORING_HISTOGRAM_METRIC_ID", "value": "video-startup-time", "description": "(Required) ID of the Monitoring Histogram Metric" } ] }, "description": "Gets histogram timeseries information for a specific metric." }, "response": [ { "id": "909fc273-c8bd-4922-a8b6-84ee03658acc", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/monitoring/metrics/:MONITORING_HISTOGRAM_METRIC_ID/histogram-timeseries?filters[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "monitoring", "metrics", ":MONITORING_HISTOGRAM_METRIC_ID", "histogram-timeseries" ], "query": [ { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" } ], "variable": [ { "key": "MONITORING_HISTOGRAM_METRIC_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"bucket_unit\": \"\",\n \"buckets\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"data\": [\n {\n \"timestamp\": \"\",\n \"sum\": \"\",\n \"p95\": \"\",\n \"median\": \"\",\n \"max_percentage\": \"\",\n \"bucket_values\": [\n {\n \"percentage\": \"\",\n \"count\": \"\"\n },\n {\n \"percentage\": \"\",\n \"count\": \"\"\n }\n ],\n \"average\": \"\"\n },\n {\n \"timestamp\": \"\",\n \"sum\": \"\",\n \"p95\": \"\",\n \"median\": \"\",\n \"max_percentage\": \"\",\n \"bucket_values\": [\n {\n \"percentage\": \"\",\n \"count\": \"\"\n },\n {\n \"percentage\": \"\",\n \"count\": \"\"\n }\n ],\n \"average\": \"\"\n }\n ],\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-909fc273-c8bd-4922-a8b6-84ee03658acc" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-5071595c-1797-4403-9954-5c502b89f37c" } ], "id": "e524061e-9683-4bd6-add1-76d5220b182d", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e524061e-9683-4bd6-add1-76d5220b182d" } ], "id": "05c38d93-399f-4f7d-8f6c-fd8b906bd40d", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-05c38d93-399f-4f7d-8f6c-fd8b906bd40d" }, { "name": "List Monitoring Metrics", "id": "dde85bcb-f583-4b2e-b428-ac9d7d541598", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/monitoring/metrics", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "monitoring", "metrics" ] }, "description": "Lists available monitoring metrics." }, "response": [ { "id": "5c13b2d1-f74b-4c19-abe4-ddb7c33e142c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/monitoring/metrics", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "monitoring", "metrics" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"name\": \"\",\n \"display_name\": \"\"\n },\n {\n \"name\": \"\",\n \"display_name\": \"\"\n }\n ],\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-5c13b2d1-f74b-4c19-abe4-ddb7c33e142c" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-dde85bcb-f583-4b2e-b428-ac9d7d541598" } ], "id": "c027c894-87a8-4755-8cb9-c8f40365c734", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-c027c894-87a8-4755-8cb9-c8f40365c734" } ], "id": "4cf7b86f-d5bd-420f-b24c-d9d2c2d17ff2", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-4cf7b86f-d5bd-420f-b24c-d9d2c2d17ff2" }, { "name": "realtime", "item": [ { "name": "dimensions", "item": [ { "name": "List Real-Time Dimensions", "id": "92da24c3-915f-48e1-9ec0-386702929c32", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/realtime/dimensions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "realtime", "dimensions" ] }, "description": "Lists available real-time dimensions. This API is now deprecated, please use the `List Monitoring Dimensions` API." }, "response": [ { "id": "4e00f179-971d-4ab6-b6c8-1a99945e4a72", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/realtime/dimensions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "realtime", "dimensions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"name\": \"\",\n \"display_name\": \"\"\n },\n {\n \"name\": \"\",\n \"display_name\": \"\"\n }\n ],\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-4e00f179-971d-4ab6-b6c8-1a99945e4a72" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-92da24c3-915f-48e1-9ec0-386702929c32" } ], "id": "9b3e0d46-2375-4fb3-a777-c22d3829bb4e", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-9b3e0d46-2375-4fb3-a777-c22d3829bb4e" }, { "name": "metrics", "item": [ { "name": "{REALTIME_METRIC_ID}", "item": [ { "name": "breakdown", "item": [ { "name": "Get Real-Time Breakdown", "id": "397fb85e-a707-4a7c-a1f1-3f6172dbe9e3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/realtime/metrics/:REALTIME_METRIC_ID/breakdown?dimension=stream_type×tamp=&filters[]=&filters[]=&order_by=field&order_direction=asc", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "realtime", "metrics", ":REALTIME_METRIC_ID", "breakdown" ], "query": [ { "description": "Dimension the specified value belongs to", "key": "dimension", "value": "stream_type" }, { "description": "Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.", "key": "timestamp", "value": "" }, { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" }, { "description": "Value to order the results by", "key": "order_by", "value": "field" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" } ], "variable": [ { "id": "e2fd1c4a-3f4d-4081-ad72-4be7b3c3eccc", "key": "REALTIME_METRIC_ID", "value": "exits-before-video-start", "description": "(Required) ID of the Realtime Metric" } ] }, "description": "Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score. This API is now deprecated, please use the `Get Monitoring Breakdown` API." }, "response": [ { "id": "39dacb4a-7125-4a6f-87e9-7d94762c3345", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/realtime/metrics/:REALTIME_METRIC_ID/breakdown?dimension=stream_type×tamp=&filters[]=&order_by=field&order_direction=asc", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "realtime", "metrics", ":REALTIME_METRIC_ID", "breakdown" ], "query": [ { "description": "Dimension the specified value belongs to", "key": "dimension", "value": "stream_type" }, { "description": "Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.", "key": "timestamp", "value": "" }, { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" }, { "description": "Value to order the results by", "key": "order_by", "value": "field" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" } ], "variable": [ { "key": "REALTIME_METRIC_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"value\": \"\",\n \"negative_impact\": \"\",\n \"metric_value\": \"\",\n \"concurrent_viewers\": \"\",\n \"starting_up_viewers\": \"\",\n \"display_value\": \"\"\n },\n {\n \"value\": \"\",\n \"negative_impact\": \"\",\n \"metric_value\": \"\",\n \"concurrent_viewers\": \"\",\n \"starting_up_viewers\": \"\",\n \"display_value\": \"\"\n }\n ],\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-39dacb4a-7125-4a6f-87e9-7d94762c3345" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-397fb85e-a707-4a7c-a1f1-3f6172dbe9e3" } ], "id": "6dd46c93-ac08-47f7-ae58-50525e7f6b37", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-6dd46c93-ac08-47f7-ae58-50525e7f6b37" }, { "name": "timeseries", "item": [ { "name": "Get Real-Time Timeseries", "id": "bccb470d-2d2d-4c03-90cb-d6d5f69d2f13", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/realtime/metrics/:REALTIME_METRIC_ID/timeseries?filters[]=&filters[]=×tamp=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "realtime", "metrics", ":REALTIME_METRIC_ID", "timeseries" ], "query": [ { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" }, { "description": "Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago.", "key": "timestamp", "value": "" } ], "variable": [ { "id": "3ed8c4c6-f863-445e-851a-e88a95b2beb5", "key": "REALTIME_METRIC_ID", "value": "exits-before-video-start", "description": "(Required) ID of the Realtime Metric" } ] }, "description": "Gets Time series information for a specific metric along with the number of concurrent viewers. This API is now deprecated, please use the `Get Monitoring Timeseries` API." }, "response": [ { "id": "9c55d0f0-d724-4f67-a914-5ca7750184bf", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/realtime/metrics/:REALTIME_METRIC_ID/timeseries?filters[]=×tamp=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "realtime", "metrics", ":REALTIME_METRIC_ID", "timeseries" ], "query": [ { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" }, { "description": "Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago.", "key": "timestamp", "value": "" } ], "variable": [ { "key": "REALTIME_METRIC_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"value\": \"\",\n \"date\": \"\",\n \"concurrent_viewers\": \"\"\n },\n {\n \"value\": \"\",\n \"date\": \"\",\n \"concurrent_viewers\": \"\"\n }\n ],\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-9c55d0f0-d724-4f67-a914-5ca7750184bf" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-bccb470d-2d2d-4c03-90cb-d6d5f69d2f13" } ], "id": "957efda7-b7f0-47f1-8850-8fdf73686b72", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-957efda7-b7f0-47f1-8850-8fdf73686b72" } ], "id": "93be807e-7cad-4f78-ab74-aad8fdfa6d2d", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-93be807e-7cad-4f78-ab74-aad8fdfa6d2d" }, { "name": "{REALTIME_HISTOGRAM_METRIC_ID}", "item": [ { "name": "histogram-timeseries", "item": [ { "name": "Get Real-Time Histogram Timeseries", "id": "cb9cf3c9-eed2-4a20-9303-36f6d625c7aa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/realtime/metrics/:REALTIME_HISTOGRAM_METRIC_ID/histogram-timeseries?filters[]=&filters[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "realtime", "metrics", ":REALTIME_HISTOGRAM_METRIC_ID", "histogram-timeseries" ], "query": [ { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" }, { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" } ], "variable": [ { "id": "cc99a01a-93c5-4a94-a195-ffa5f6a66bfc", "key": "REALTIME_HISTOGRAM_METRIC_ID", "value": "video-startup-time", "description": "(Required) ID of the Realtime Histogram Metric" } ] }, "description": "Gets histogram timeseries information for a specific metric. This API is now deprecated, please use the `Get Monitoring Histogram Timeseries` API." }, "response": [ { "id": "fb976e59-42e1-474b-af3b-4481122cc630", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/realtime/metrics/:REALTIME_HISTOGRAM_METRIC_ID/histogram-timeseries?filters[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "realtime", "metrics", ":REALTIME_HISTOGRAM_METRIC_ID", "histogram-timeseries" ], "query": [ { "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "key": "filters[]", "value": "" } ], "variable": [ { "key": "REALTIME_HISTOGRAM_METRIC_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"bucket_unit\": \"\",\n \"buckets\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"data\": [\n {\n \"timestamp\": \"\",\n \"sum\": \"\",\n \"p95\": \"\",\n \"median\": \"\",\n \"max_percentage\": \"\",\n \"bucket_values\": [\n {\n \"percentage\": \"\",\n \"count\": \"\"\n },\n {\n \"percentage\": \"\",\n \"count\": \"\"\n }\n ],\n \"average\": \"\"\n },\n {\n \"timestamp\": \"\",\n \"sum\": \"\",\n \"p95\": \"\",\n \"median\": \"\",\n \"max_percentage\": \"\",\n \"bucket_values\": [\n {\n \"percentage\": \"\",\n \"count\": \"\"\n },\n {\n \"percentage\": \"\",\n \"count\": \"\"\n }\n ],\n \"average\": \"\"\n }\n ],\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-fb976e59-42e1-474b-af3b-4481122cc630" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-cb9cf3c9-eed2-4a20-9303-36f6d625c7aa" } ], "id": "7409a4d4-2fb1-4829-a93a-ed8a00a680ba", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-7409a4d4-2fb1-4829-a93a-ed8a00a680ba" } ], "id": "2e4754df-7a71-462e-8ed2-31d98cc7d682", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-2e4754df-7a71-462e-8ed2-31d98cc7d682" }, { "name": "List Real-Time Metrics", "id": "c4542b43-2ecf-4606-92fc-58b5ccedd2dd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/realtime/metrics", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "realtime", "metrics" ] }, "description": "Lists available real-time metrics. This API is now deprecated, please use the `List Monitoring Metrics` API." }, "response": [ { "id": "67dc5e7d-e9f2-457c-bcca-489e4e319bfa", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/realtime/metrics", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "realtime", "metrics" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"name\": \"\",\n \"display_name\": \"\"\n },\n {\n \"name\": \"\",\n \"display_name\": \"\"\n }\n ],\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-67dc5e7d-e9f2-457c-bcca-489e4e319bfa" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-c4542b43-2ecf-4606-92fc-58b5ccedd2dd" } ], "id": "bb5cd203-be63-457c-99cb-37c0bc4464c4", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-bb5cd203-be63-457c-99cb-37c0bc4464c4" } ], "id": "235f1870-99ce-406e-8054-cfd9ea570756", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-235f1870-99ce-406e-8054-cfd9ea570756" }, { "name": "incidents", "item": [ { "name": "{INCIDENT_ID}", "item": [ { "name": "related", "item": [ { "name": "List Related Incidents", "id": "68f66bc8-22e2-41ab-b50e-b2a95b153e76", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/incidents/:INCIDENT_ID/related?limit=25&page=1&order_by=field&order_direction=asc", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "incidents", ":INCIDENT_ID", "related" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Value to order the results by", "key": "order_by", "value": "field" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" } ], "variable": [ { "id": "51629e9a-7cd8-41fc-8f65-5ff11b5b3d59", "key": "INCIDENT_ID", "value": "", "description": "(Required) ID of the Incident" } ] }, "description": "Returns all the incidents that seem related to a specific incident." }, "response": [ { "id": "31ce43ed-8dbd-4436-ae3f-02a47e6d48a0", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/incidents/:INCIDENT_ID/related?limit=25&page=1&order_by=field&order_direction=asc", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "incidents", ":INCIDENT_ID", "related" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Value to order the results by", "key": "order_by", "value": "field" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" } ], "variable": [ { "key": "INCIDENT_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"started_at\": \"\",\n \"resolved_at\": \"\",\n \"incident_key\": \"\",\n \"measurement\": \"\",\n \"measured_value\": \"\",\n \"measured_value_on_close\": \"\",\n \"sample_size\": \"\",\n \"sample_size_unit\": \"\",\n \"breakdowns\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"severity\": \"\",\n \"description\": \"\",\n \"impact\": \"\",\n \"affected_views\": \"\",\n \"affected_views_per_hour\": \"\",\n \"affected_views_per_hour_on_open\": \"\",\n \"threshold\": \"\",\n \"notifications\": [\n {\n \"queued_at\": \"\",\n \"id\": \"\",\n \"attempted_at\": \"\"\n },\n {\n \"queued_at\": \"\",\n \"id\": \"\",\n \"attempted_at\": \"\"\n }\n ],\n \"notification_rules\": [\n {\n \"status\": \"\",\n \"rules\": [\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"property_id\": \"\",\n \"id\": \"\",\n \"action\": \"\"\n },\n {\n \"status\": \"\",\n \"rules\": [\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"property_id\": \"\",\n \"id\": \"\",\n \"action\": \"\"\n }\n ],\n \"error_description\": \"\",\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"started_at\": \"\",\n \"resolved_at\": \"\",\n \"incident_key\": \"\",\n \"measurement\": \"\",\n \"measured_value\": \"\",\n \"measured_value_on_close\": \"\",\n \"sample_size\": \"\",\n \"sample_size_unit\": \"\",\n \"breakdowns\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"severity\": \"\",\n \"description\": \"\",\n \"impact\": \"\",\n \"affected_views\": \"\",\n \"affected_views_per_hour\": \"\",\n \"affected_views_per_hour_on_open\": \"\",\n \"threshold\": \"\",\n \"notifications\": [\n {\n \"queued_at\": \"\",\n \"id\": \"\",\n \"attempted_at\": \"\"\n },\n {\n \"queued_at\": \"\",\n \"id\": \"\",\n \"attempted_at\": \"\"\n }\n ],\n \"notification_rules\": [\n {\n \"status\": \"\",\n \"rules\": [\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"property_id\": \"\",\n \"id\": \"\",\n \"action\": \"\"\n },\n {\n \"status\": \"\",\n \"rules\": [\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"property_id\": \"\",\n \"id\": \"\",\n \"action\": \"\"\n }\n ],\n \"error_description\": \"\",\n \"status\": \"\"\n }\n ],\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-31ce43ed-8dbd-4436-ae3f-02a47e6d48a0" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-68f66bc8-22e2-41ab-b50e-b2a95b153e76" } ], "id": "12cf592b-a8b9-412b-a8cc-85d4aadf2e8b", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-12cf592b-a8b9-412b-a8cc-85d4aadf2e8b" }, { "name": "Get an Incident", "id": "14ccb598-892e-4c92-bf99-9c6c29c1e3e5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/incidents/:INCIDENT_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "incidents", ":INCIDENT_ID" ], "variable": [ { "id": "2c85fd21-9c68-4315-a97e-5bc45e3a557e", "key": "INCIDENT_ID", "value": "", "description": "(Required) ID of the Incident" } ] }, "description": "Returns the details of an incident." }, "response": [ { "id": "810ec2cb-461a-4776-9f7a-97592992c39d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/incidents/:INCIDENT_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "incidents", ":INCIDENT_ID" ], "variable": [ { "key": "INCIDENT_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"started_at\": \"\",\n \"resolved_at\": \"\",\n \"incident_key\": \"\",\n \"measurement\": \"\",\n \"measured_value\": \"\",\n \"measured_value_on_close\": \"\",\n \"sample_size\": \"\",\n \"sample_size_unit\": \"\",\n \"breakdowns\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"severity\": \"\",\n \"description\": \"\",\n \"impact\": \"\",\n \"affected_views\": \"\",\n \"affected_views_per_hour\": \"\",\n \"affected_views_per_hour_on_open\": \"\",\n \"threshold\": \"\",\n \"notifications\": [\n {\n \"queued_at\": \"\",\n \"id\": \"\",\n \"attempted_at\": \"\"\n },\n {\n \"queued_at\": \"\",\n \"id\": \"\",\n \"attempted_at\": \"\"\n }\n ],\n \"notification_rules\": [\n {\n \"status\": \"\",\n \"rules\": [\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"property_id\": \"\",\n \"id\": \"\",\n \"action\": \"\"\n },\n {\n \"status\": \"\",\n \"rules\": [\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"property_id\": \"\",\n \"id\": \"\",\n \"action\": \"\"\n }\n ],\n \"error_description\": \"\",\n \"status\": \"\"\n },\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-810ec2cb-461a-4776-9f7a-97592992c39d" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-14ccb598-892e-4c92-bf99-9c6c29c1e3e5" } ], "id": "fa369e48-4b6f-411a-9a9d-f13d232ccd41", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-fa369e48-4b6f-411a-9a9d-f13d232ccd41" }, { "name": "List Incidents", "id": "b5dd6b78-f0b4-41ec-b1ed-c241fcaf5cc6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/incidents?limit=25&page=1&order_by=field&order_direction=asc&status=closed&severity=alert", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "incidents" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Value to order the results by", "key": "order_by", "value": "field" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" }, { "description": "Status to filter incidents by", "key": "status", "value": "closed" }, { "description": "Severity to filter incidents by", "key": "severity", "value": "alert" } ] }, "description": "Returns a list of incidents." }, "response": [ { "id": "612c4466-02d9-4bab-9b63-baf76cb9cbd3", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/incidents?limit=25&page=1&order_by=field&order_direction=asc&status=closed&severity=alert", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "incidents" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Value to order the results by", "key": "order_by", "value": "field" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" }, { "description": "Status to filter incidents by", "key": "status", "value": "closed" }, { "description": "Severity to filter incidents by", "key": "severity", "value": "alert" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"started_at\": \"\",\n \"resolved_at\": \"\",\n \"incident_key\": \"\",\n \"measurement\": \"\",\n \"measured_value\": \"\",\n \"measured_value_on_close\": \"\",\n \"sample_size\": \"\",\n \"sample_size_unit\": \"\",\n \"breakdowns\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"severity\": \"\",\n \"description\": \"\",\n \"impact\": \"\",\n \"affected_views\": \"\",\n \"affected_views_per_hour\": \"\",\n \"affected_views_per_hour_on_open\": \"\",\n \"threshold\": \"\",\n \"notifications\": [\n {\n \"queued_at\": \"\",\n \"id\": \"\",\n \"attempted_at\": \"\"\n },\n {\n \"queued_at\": \"\",\n \"id\": \"\",\n \"attempted_at\": \"\"\n }\n ],\n \"notification_rules\": [\n {\n \"status\": \"\",\n \"rules\": [\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"property_id\": \"\",\n \"id\": \"\",\n \"action\": \"\"\n },\n {\n \"status\": \"\",\n \"rules\": [\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"property_id\": \"\",\n \"id\": \"\",\n \"action\": \"\"\n }\n ],\n \"error_description\": \"\",\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"started_at\": \"\",\n \"resolved_at\": \"\",\n \"incident_key\": \"\",\n \"measurement\": \"\",\n \"measured_value\": \"\",\n \"measured_value_on_close\": \"\",\n \"sample_size\": \"\",\n \"sample_size_unit\": \"\",\n \"breakdowns\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"severity\": \"\",\n \"description\": \"\",\n \"impact\": \"\",\n \"affected_views\": \"\",\n \"affected_views_per_hour\": \"\",\n \"affected_views_per_hour_on_open\": \"\",\n \"threshold\": \"\",\n \"notifications\": [\n {\n \"queued_at\": \"\",\n \"id\": \"\",\n \"attempted_at\": \"\"\n },\n {\n \"queued_at\": \"\",\n \"id\": \"\",\n \"attempted_at\": \"\"\n }\n ],\n \"notification_rules\": [\n {\n \"status\": \"\",\n \"rules\": [\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"property_id\": \"\",\n \"id\": \"\",\n \"action\": \"\"\n },\n {\n \"status\": \"\",\n \"rules\": [\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"property_id\": \"\",\n \"id\": \"\",\n \"action\": \"\"\n }\n ],\n \"error_description\": \"\",\n \"status\": \"\"\n }\n ],\n \"timeframe\": [\n \"\",\n \"\"\n ],\n \"total_row_count\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-612c4466-02d9-4bab-9b63-baf76cb9cbd3" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b5dd6b78-f0b4-41ec-b1ed-c241fcaf5cc6" } ], "id": "41342221-8aa2-44cd-9a58-8632251a38f3", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-41342221-8aa2-44cd-9a58-8632251a38f3" }, { "name": "annotations", "item": [ { "name": "{ANNOTATION_ID}", "item": [ { "name": "Get Annotation", "id": "59b08570-8f30-43ef-9b6b-9c6183bdf7e0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/annotations/:ANNOTATION_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "annotations", ":ANNOTATION_ID" ], "variable": [ { "id": "c8745231-7bdc-4f92-99ce-9f1ee0d8c919", "key": "ANNOTATION_ID", "value": "", "description": "(Required) The annotation ID" } ] }, "description": "Returns the details of a specific annotation." }, "response": [ { "id": "48fbc5c7-38b8-415d-bd04-5ca97b439c71", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/annotations/:ANNOTATION_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "annotations", ":ANNOTATION_ID" ], "variable": [ { "key": "ANNOTATION_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"note\": \"\",\n \"date\": \"\",\n \"sub_property_id\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-48fbc5c7-38b8-415d-bd04-5ca97b439c71" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-59b08570-8f30-43ef-9b6b-9c6183bdf7e0" }, { "name": "Update Annotation", "id": "7ae0c9e5-765c-49eb-93d6-70f914e106a4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"note\": \"\",\n \"date\": \"\",\n \"sub_property_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/data/v1/annotations/:ANNOTATION_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "annotations", ":ANNOTATION_ID" ], "variable": [ { "id": "967907e2-1582-431e-86cc-32bb1e45f8b8", "key": "ANNOTATION_ID", "value": "", "description": "(Required) The annotation ID" } ] }, "description": "Updates an existing annotation." }, "response": [ { "id": "ddf42b57-edd5-485f-8191-7306a783c4ee", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"note\": \"\",\n \"date\": \"\",\n \"sub_property_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/data/v1/annotations/:ANNOTATION_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "annotations", ":ANNOTATION_ID" ], "variable": [ { "key": "ANNOTATION_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"note\": \"\",\n \"date\": \"\",\n \"sub_property_id\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-ddf42b57-edd5-485f-8191-7306a783c4ee" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-7ae0c9e5-765c-49eb-93d6-70f914e106a4" }, { "name": "Delete Annotation", "id": "19e4b69c-7d1c-4e80-aba6-5c23c989a969", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "https://api.mux.com/data/v1/annotations/:ANNOTATION_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "annotations", ":ANNOTATION_ID" ], "variable": [ { "id": "e14ec759-108b-4626-b028-17749cb71afe", "key": "ANNOTATION_ID", "value": "", "description": "(Required) The annotation ID" } ] }, "description": "Deletes an annotation." }, "response": [ { "id": "ff26cb3c-bc93-4cc3-bb1a-6d7e42647c8c", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/annotations/:ANNOTATION_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "annotations", ":ANNOTATION_ID" ], "variable": [ { "key": "ANNOTATION_ID" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-ff26cb3c-bc93-4cc3-bb1a-6d7e42647c8c" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-19e4b69c-7d1c-4e80-aba6-5c23c989a969" } ], "id": "a72e79b0-5d4a-4b9c-b4fa-7cc52a3c0bc0", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a72e79b0-5d4a-4b9c-b4fa-7cc52a3c0bc0" }, { "name": "List Annotations", "id": "32a3aa6d-f541-4f13-96ae-be1c6a851653", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/data/v1/annotations?limit=25&page=1&order_direction=asc&timeframe[]=&timeframe[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "annotations" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" } ] }, "description": "Returns a list of annotations." }, "response": [ { "id": "c7c1e145-401c-46de-934b-4a2bf1f6ac3c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/data/v1/annotations?limit=25&page=1&order_direction=asc&timeframe[]=", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "annotations" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" }, { "description": "Sort order.", "key": "order_direction", "value": "asc" }, { "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n", "key": "timeframe[]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"note\": \"\",\n \"date\": \"\",\n \"sub_property_id\": \"\"\n },\n {\n \"id\": \"\",\n \"note\": \"\",\n \"date\": \"\",\n \"sub_property_id\": \"\"\n }\n ],\n \"total_row_count\": \"\",\n \"timeframe\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-c7c1e145-401c-46de-934b-4a2bf1f6ac3c" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-32a3aa6d-f541-4f13-96ae-be1c6a851653" }, { "name": "Create Annotation", "id": "a50d62bc-f927-4bed-b254-0c0461d70207", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"note\": \"\",\n \"date\": \"\",\n \"sub_property_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/data/v1/annotations", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "annotations" ] }, "description": "Creates a new annotation." }, "response": [ { "id": "1096966d-ea5f-4cd1-bb8c-9b3fc693b040", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"note\": \"\",\n \"date\": \"\",\n \"sub_property_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/data/v1/annotations", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "data", "v1", "annotations" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"note\": \"\",\n \"date\": \"\",\n \"sub_property_id\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-1096966d-ea5f-4cd1-bb8c-9b3fc693b040" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a50d62bc-f927-4bed-b254-0c0461d70207" } ], "id": "550163d3-1bdd-428d-8ae4-fcbba5135e8e", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-550163d3-1bdd-428d-8ae4-fcbba5135e8e" } ], "id": "62be6adb-7108-45ac-b82c-c00303a3e65d", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-62be6adb-7108-45ac-b82c-c00303a3e65d" } ], "id": "ba9fc780-584e-4f83-b31c-a72fe989ce4b", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-ba9fc780-584e-4f83-b31c-a72fe989ce4b" }, { "name": "system", "item": [ { "name": "v1", "item": [ { "name": "whoami", "item": [ { "name": "Retrieve Information About Your Current Access Token.", "id": "80eb7a0b-53a7-4abf-80a6-38b31780fd34", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/system/v1/whoami", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "system", "v1", "whoami" ] }, "description": "Retrieve information about your current access token, including organization, environment, and permissions. Note that this can only be access with an access token, and _all_ access tokens can access this route, regardless of what permissions they have assigned." }, "response": [ { "id": "f48c8eb8-e826-44a0-80e8-44a0bc608201", "name": "Information retrieved successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/system/v1/whoami", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "system", "v1", "whoami" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"organization_name\": \"\",\n \"organization_id\": \"\",\n \"environment_type\": \"\",\n \"environment_name\": \"\",\n \"environment_id\": \"\",\n \"access_token_name\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f48c8eb8-e826-44a0-80e8-44a0bc608201" }, { "id": "e0d1ff31-fc31-421c-b422-d5c7be243256", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/system/v1/whoami", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "system", "v1", "whoami" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ]\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e0d1ff31-fc31-421c-b422-d5c7be243256" }, { "id": "fb33c9d4-f402-465a-ae6a-514ed42b0d44", "name": "Rate limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/system/v1/whoami", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "system", "v1", "whoami" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-fb33c9d4-f402-465a-ae6a-514ed42b0d44" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-80eb7a0b-53a7-4abf-80a6-38b31780fd34" } ], "id": "35a08534-2ead-4954-8271-7fb967e0036f", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-35a08534-2ead-4954-8271-7fb967e0036f" }, { "name": "signing-keys", "item": [ { "name": "{SIGNING_KEY_ID}", "item": [ { "name": "Retrieve a Signing Key", "id": "908b88d7-5590-46ce-b448-3fc6ce3b38bc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/system/v1/signing-keys/:SIGNING_KEY_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "system", "v1", "signing-keys", ":SIGNING_KEY_ID" ], "variable": [ { "id": "d40c40f7-83ef-4062-94a9-88d4132b6438", "key": "SIGNING_KEY_ID", "value": "", "description": "(Required) The ID of the signing key." } ] }, "description": "Retrieves the details of a signing key that has previously\nbeen created. Supply the unique signing key ID that was returned from your\nprevious request, and Mux will return the corresponding signing key information.\n**The private key is not returned in this response.**\n" }, "response": [ { "id": "f91b533e-9002-4f22-beb7-14ff2410fcaf", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/system/v1/signing-keys/:SIGNING_KEY_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "system", "v1", "signing-keys", ":SIGNING_KEY_ID" ], "variable": [ { "key": "SIGNING_KEY_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"private_key\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f91b533e-9002-4f22-beb7-14ff2410fcaf" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-908b88d7-5590-46ce-b448-3fc6ce3b38bc" }, { "name": "Delete a Signing Key", "id": "8c584d73-5a47-4e4f-bed7-ad03d9fd2eb7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "https://api.mux.com/system/v1/signing-keys/:SIGNING_KEY_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "system", "v1", "signing-keys", ":SIGNING_KEY_ID" ], "variable": [ { "id": "4fd73366-0a76-45ef-9a1e-a2484edd7514", "key": "SIGNING_KEY_ID", "value": "", "description": "(Required) The ID of the signing key." } ] }, "description": "Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no JWTs can be signed using the key again." }, "response": [ { "id": "c7852a26-35b2-4848-bf78-c6b7db1aac4d", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/system/v1/signing-keys/:SIGNING_KEY_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "system", "v1", "signing-keys", ":SIGNING_KEY_ID" ], "variable": [ { "key": "SIGNING_KEY_ID" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-c7852a26-35b2-4848-bf78-c6b7db1aac4d" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-8c584d73-5a47-4e4f-bed7-ad03d9fd2eb7" } ], "id": "7be18bca-dc92-4a50-a5e7-fa8f2ecc3387", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-7be18bca-dc92-4a50-a5e7-fa8f2ecc3387" }, { "name": "Create a Signing Key", "id": "81733427-1a6b-45e0-b614-fa128d3defb4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/system/v1/signing-keys", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "system", "v1", "signing-keys" ] }, "description": "Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens." }, "response": [ { "id": "6bde8b31-dd37-40aa-9e73-f3de52802c63", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/system/v1/signing-keys", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "system", "v1", "signing-keys" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"private_key\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-6bde8b31-dd37-40aa-9e73-f3de52802c63" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-81733427-1a6b-45e0-b614-fa128d3defb4" }, { "name": "List Signing Keys", "id": "a65dff68-1da5-426d-89fa-de91fa5d6b35", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/system/v1/signing-keys?limit=25&page=1", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "system", "v1", "signing-keys" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" } ] }, "description": "Returns a list of signing keys." }, "response": [ { "id": "bccf4f5a-b22c-4d6c-b46a-0536905951c9", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/system/v1/signing-keys?limit=25&page=1", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "system", "v1", "signing-keys" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "25" }, { "description": "Offset by this many pages, of the size of `limit`", "key": "page", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"private_key\": \"\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"private_key\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-bccf4f5a-b22c-4d6c-b46a-0536905951c9" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a65dff68-1da5-426d-89fa-de91fa5d6b35" } ], "id": "e54be1f3-c9d5-4289-b572-561bc506663e", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e54be1f3-c9d5-4289-b572-561bc506663e" } ], "id": "9d9174dd-8bdf-4e78-8a26-a788155d526f", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-9d9174dd-8bdf-4e78-8a26-a788155d526f" } ], "id": "a77e8ae0-422b-4143-a970-3f8e8a22b9e8", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a77e8ae0-422b-4143-a970-3f8e8a22b9e8" }, { "name": "robots", "item": [ { "name": "v0", "item": [ { "name": "jobs", "item": [ { "name": "{JOB_ID}", "item": [ { "name": "cancel", "item": [ { "name": "Cancel a Job", "id": "b0b2f9c9-caec-40f4-908b-0246a9b12980", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/:JOB_ID/cancel", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", ":JOB_ID", "cancel" ], "variable": [ { "id": "4e7732c3-6d70-4058-a464-90f5860e7622", "key": "JOB_ID", "value": "", "description": "(Required) " } ] }, "description": "Cancels a job that is currently pending or processing." }, "response": [ { "id": "d375c0eb-f5b5-454f-9709-af0750852a87", "name": "Job cancelled successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/:JOB_ID/cancel", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", ":JOB_ID", "cancel" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"workflow\": \"summarize\",\n \"status\": \"pending\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-d375c0eb-f5b5-454f-9709-af0750852a87" }, { "id": "a52c2dab-980e-49e7-b9c3-a3890f5c5a6d", "name": "Robots is not enabled for this environment. Accept the Robots beta terms in the Mux Dashboard to enable access.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/:JOB_ID/cancel", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", ":JOB_ID", "cancel" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a52c2dab-980e-49e7-b9c3-a3890f5c5a6d" }, { "id": "e5a7b42e-d128-4613-867e-48b8c686c6dc", "name": "Job not found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/:JOB_ID/cancel", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", ":JOB_ID", "cancel" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e5a7b42e-d128-4613-867e-48b8c686c6dc" }, { "id": "858692d4-0d3c-40d7-bf60-029a5fd865b2", "name": "Job is already in a terminal state", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/:JOB_ID/cancel", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", ":JOB_ID", "cancel" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-858692d4-0d3c-40d7-bf60-029a5fd865b2" }, { "id": "f598583c-88d8-4250-9453-989cd7d3d037", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/:JOB_ID/cancel", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", ":JOB_ID", "cancel" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f598583c-88d8-4250-9453-989cd7d3d037" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b0b2f9c9-caec-40f4-908b-0246a9b12980" } ], "id": "1d968a57-a533-4a83-8e57-af69f05fb260", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-1d968a57-a533-4a83-8e57-af69f05fb260" } ], "id": "f23a8f9e-c914-4f9b-981c-5bfcda8051b4", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f23a8f9e-c914-4f9b-981c-5bfcda8051b4" }, { "name": "ask-questions", "item": [ { "name": "{JOB_ID}", "item": [ { "name": "Get an 'ask-Questions' Job", "id": "5c64fb4e-f052-48d4-b94a-b7e02debc6c9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/ask-questions/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "ask-questions", ":JOB_ID" ], "variable": [ { "id": "01a92544-b8d3-4378-b2c6-b7d6352e2f98", "key": "JOB_ID", "value": "", "description": "(Required) " } ] }, "description": "Retrieves the current status and results of an 'ask-questions' job. Jobs are automatically deleted after 30 days." }, "response": [ { "id": "b8c363eb-d079-4af5-be11-5aaf0e56323c", "name": "Current status for the requested job", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/ask-questions/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "ask-questions", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"units_consumed\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"workflow\": \"ask-questions\",\n \"parameters\": {\n \"asset_id\": \"\",\n \"questions\": [\n {\n \"question\": \"\",\n \"answer_options\": [\n \"\"\n ],\n \"free_form_reply\": \"\"\n }\n ],\n \"language_code\": \"\",\n \"max_free_form_answer_length\": 500\n },\n \"status\": \"processing\",\n \"passthrough\": \"\",\n \"outputs\": {\n \"answers\": [\n {\n \"question\": \"\",\n \"answer\": \"\",\n \"confidence\": \"\",\n \"reasoning\": \"\",\n \"skipped\": \"\"\n }\n ]\n },\n \"errors\": [\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"resources\": {\n \"assets\": [\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n },\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b8c363eb-d079-4af5-be11-5aaf0e56323c" }, { "id": "d8322336-b1bf-4040-b7d0-86184cc0258f", "name": "Robots is not enabled for this environment. Accept the Robots beta terms in the Mux Dashboard to enable access.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/ask-questions/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "ask-questions", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-d8322336-b1bf-4040-b7d0-86184cc0258f" }, { "id": "e7886bc8-0c27-4dcd-8c4a-0e34599dc08c", "name": "No job exists for the supplied id", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/ask-questions/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "ask-questions", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e7886bc8-0c27-4dcd-8c4a-0e34599dc08c" }, { "id": "6e8b613e-1ec9-4a29-b2ef-640b99fdaca7", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/ask-questions/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "ask-questions", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-6e8b613e-1ec9-4a29-b2ef-640b99fdaca7" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-5c64fb4e-f052-48d4-b94a-b7e02debc6c9" } ], "id": "0040ea02-44bc-489f-a478-cfd77d34386e", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-0040ea02-44bc-489f-a478-cfd77d34386e" }, { "name": "Create an 'ask-Questions' Job", "id": "037f57f4-a342-423d-8477-2874c45f15a2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"questions\": [\n {\n \"question\": \"\",\n \"answer_options\": [\n \"\"\n ],\n \"free_form_reply\": \"\"\n }\n ],\n \"language_code\": \"\",\n \"max_free_form_answer_length\": 500\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/ask-questions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "ask-questions" ] }, "description": "Creates a new job that uses AI to answer questions about a Mux Video asset." }, "response": [ { "id": "6e230f9c-5f2c-470f-90b7-c1253031eb84", "name": "Ask questions job queued", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"questions\": [\n {\n \"question\": \"\",\n \"answer_options\": [\n \"\"\n ],\n \"free_form_reply\": \"\"\n }\n ],\n \"language_code\": \"\",\n \"max_free_form_answer_length\": 500\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/ask-questions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "ask-questions" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"units_consumed\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"workflow\": \"ask-questions\",\n \"parameters\": {\n \"asset_id\": \"\",\n \"questions\": [\n {\n \"question\": \"\",\n \"answer_options\": [\n \"\"\n ],\n \"free_form_reply\": \"\"\n }\n ],\n \"language_code\": \"\",\n \"max_free_form_answer_length\": 500\n },\n \"status\": \"processing\",\n \"passthrough\": \"\",\n \"outputs\": {\n \"answers\": [\n {\n \"question\": \"\",\n \"answer\": \"\",\n \"confidence\": \"\",\n \"reasoning\": \"\",\n \"skipped\": \"\"\n }\n ]\n },\n \"errors\": [\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"resources\": {\n \"assets\": [\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n },\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-6e230f9c-5f2c-470f-90b7-c1253031eb84" }, { "id": "b664f02d-a247-4b19-93c7-8e0c4239a331", "name": "Missing Mux credentials", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"questions\": [\n {\n \"question\": \"\",\n \"answer_options\": [\n \"\"\n ],\n \"free_form_reply\": \"\"\n }\n ],\n \"language_code\": \"\",\n \"max_free_form_answer_length\": 500\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/ask-questions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "ask-questions" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b664f02d-a247-4b19-93c7-8e0c4239a331" }, { "id": "921c656c-4128-433d-862c-a32724a0a38e", "name": "Robots is not enabled for this environment. Accept the Robots beta terms in the Mux Dashboard to enable access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"questions\": [\n {\n \"question\": \"\",\n \"answer_options\": [\n \"\"\n ],\n \"free_form_reply\": \"\"\n }\n ],\n \"language_code\": \"\",\n \"max_free_form_answer_length\": 500\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/ask-questions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "ask-questions" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-921c656c-4128-433d-862c-a32724a0a38e" }, { "id": "3dea7772-7a8c-4c33-a0ee-ec61c238928d", "name": "Asset not found or missing playback ID", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"questions\": [\n {\n \"question\": \"\",\n \"answer_options\": [\n \"\"\n ],\n \"free_form_reply\": \"\"\n }\n ],\n \"language_code\": \"\",\n \"max_free_form_answer_length\": 500\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/ask-questions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "ask-questions" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-3dea7772-7a8c-4c33-a0ee-ec61c238928d" }, { "id": "d760759e-7f38-4dfe-a6f3-201caa985f67", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"questions\": [\n {\n \"question\": \"\",\n \"answer_options\": [\n \"\"\n ],\n \"free_form_reply\": \"\"\n }\n ],\n \"language_code\": \"\",\n \"max_free_form_answer_length\": 500\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/ask-questions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "ask-questions" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-d760759e-7f38-4dfe-a6f3-201caa985f67" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-037f57f4-a342-423d-8477-2874c45f15a2" } ], "id": "7f3e910b-22ea-4137-b095-6b40cf723089", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-7f3e910b-22ea-4137-b095-6b40cf723089" }, { "name": "edit-captions", "item": [ { "name": "{JOB_ID}", "item": [ { "name": "Get an 'edit-Captions' Job", "id": "e2440f77-4a3d-4b6c-a67a-8ff2e25c8888", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/edit-captions/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "edit-captions", ":JOB_ID" ], "variable": [ { "id": "34474e66-a44f-4369-8dbd-2e0b44a0c7f2", "key": "JOB_ID", "value": "", "description": "(Required) " } ] }, "description": "Retrieves the current status and results of an 'edit-captions' job." }, "response": [ { "id": "95fa753c-0cd8-44de-b079-ccece8fc56fb", "name": "Current status for the requested job", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/edit-captions/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "edit-captions", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"units_consumed\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"workflow\": \"edit-captions\",\n \"parameters\": {\n \"asset_id\": \"\",\n \"track_id\": \"\",\n \"auto_censor_profanity\": {\n \"detection_method\": \"llm\",\n \"mode\": \"blank\",\n \"always_censor\": [\n \"\",\n \"\"\n ],\n \"never_censor\": [\n \"\",\n \"\"\n ]\n },\n \"replacements\": [\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n },\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n }\n ],\n \"upload_to_mux\": true,\n \"delete_original_track\": true,\n \"track_name_suffix\": \"\"\n },\n \"status\": \"processing\",\n \"passthrough\": \"\",\n \"outputs\": {\n \"total_replacement_count\": \"\",\n \"uploaded_track_id\": \"\",\n \"temporary_vtt_url\": \"\"\n },\n \"errors\": [\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"resources\": {\n \"assets\": [\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n },\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-95fa753c-0cd8-44de-b079-ccece8fc56fb" }, { "id": "134c3bfb-9052-4636-94ab-f4aaf319a36a", "name": "Robots is not enabled for this environment. Accept the Robots beta terms in the Mux Dashboard to enable access.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/edit-captions/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "edit-captions", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-134c3bfb-9052-4636-94ab-f4aaf319a36a" }, { "id": "e9cb096b-fcab-4d66-953c-338e77bb88e3", "name": "No job exists for the supplied id", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/edit-captions/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "edit-captions", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e9cb096b-fcab-4d66-953c-338e77bb88e3" }, { "id": "2fedbf16-1616-4f9a-8da3-61f77869bc02", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/edit-captions/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "edit-captions", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-2fedbf16-1616-4f9a-8da3-61f77869bc02" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e2440f77-4a3d-4b6c-a67a-8ff2e25c8888" } ], "id": "dcfd575e-dd3e-4f77-baa3-c3f476dba348", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-dcfd575e-dd3e-4f77-baa3-c3f476dba348" }, { "name": "Create an 'edit-Captions' Job", "id": "2ac80905-5c94-4ce6-88f9-32b92db71a45", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"track_id\": \"\",\n \"auto_censor_profanity\": {\n \"detection_method\": \"llm\",\n \"mode\": \"blank\",\n \"always_censor\": [\n \"\",\n \"\"\n ],\n \"never_censor\": [\n \"\",\n \"\"\n ]\n },\n \"replacements\": [\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n },\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n }\n ],\n \"upload_to_mux\": true,\n \"delete_original_track\": true,\n \"track_name_suffix\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/edit-captions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "edit-captions" ] }, "description": "Creates a new job that edits an existing Mux text track using static replacements and optional profanity censoring. Provide at least one of `replacements` or `auto_censor_profanity`." }, "response": [ { "id": "0619db66-e347-4349-8476-5af9be370d67", "name": "Caption editing job queued", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"track_id\": \"\",\n \"auto_censor_profanity\": {\n \"detection_method\": \"llm\",\n \"mode\": \"blank\",\n \"always_censor\": [\n \"\",\n \"\"\n ],\n \"never_censor\": [\n \"\",\n \"\"\n ]\n },\n \"replacements\": [\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n },\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n }\n ],\n \"upload_to_mux\": true,\n \"delete_original_track\": true,\n \"track_name_suffix\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/edit-captions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "edit-captions" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"units_consumed\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"workflow\": \"edit-captions\",\n \"parameters\": {\n \"asset_id\": \"\",\n \"track_id\": \"\",\n \"auto_censor_profanity\": {\n \"detection_method\": \"llm\",\n \"mode\": \"blank\",\n \"always_censor\": [\n \"\",\n \"\"\n ],\n \"never_censor\": [\n \"\",\n \"\"\n ]\n },\n \"replacements\": [\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n },\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n }\n ],\n \"upload_to_mux\": true,\n \"delete_original_track\": true,\n \"track_name_suffix\": \"\"\n },\n \"status\": \"processing\",\n \"passthrough\": \"\",\n \"outputs\": {\n \"total_replacement_count\": \"\",\n \"uploaded_track_id\": \"\",\n \"temporary_vtt_url\": \"\"\n },\n \"errors\": [\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"resources\": {\n \"assets\": [\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n },\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-0619db66-e347-4349-8476-5af9be370d67" }, { "id": "794e3479-d990-43d6-9a52-a4d31e9bce96", "name": "Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"track_id\": \"\",\n \"auto_censor_profanity\": {\n \"detection_method\": \"llm\",\n \"mode\": \"blank\",\n \"always_censor\": [\n \"\",\n \"\"\n ],\n \"never_censor\": [\n \"\",\n \"\"\n ]\n },\n \"replacements\": [\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n },\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n }\n ],\n \"upload_to_mux\": true,\n \"delete_original_track\": true,\n \"track_name_suffix\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/edit-captions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "edit-captions" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-794e3479-d990-43d6-9a52-a4d31e9bce96" }, { "id": "81593774-8195-4d8b-ae09-79a72e9542f7", "name": "Missing Mux credentials", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"track_id\": \"\",\n \"auto_censor_profanity\": {\n \"detection_method\": \"llm\",\n \"mode\": \"blank\",\n \"always_censor\": [\n \"\",\n \"\"\n ],\n \"never_censor\": [\n \"\",\n \"\"\n ]\n },\n \"replacements\": [\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n },\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n }\n ],\n \"upload_to_mux\": true,\n \"delete_original_track\": true,\n \"track_name_suffix\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/edit-captions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "edit-captions" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-81593774-8195-4d8b-ae09-79a72e9542f7" }, { "id": "2a1e5a90-7340-4844-995a-b3fd0015af82", "name": "Robots is not enabled for this environment. Accept the Robots beta terms in the Mux Dashboard to enable access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"track_id\": \"\",\n \"auto_censor_profanity\": {\n \"detection_method\": \"llm\",\n \"mode\": \"blank\",\n \"always_censor\": [\n \"\",\n \"\"\n ],\n \"never_censor\": [\n \"\",\n \"\"\n ]\n },\n \"replacements\": [\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n },\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n }\n ],\n \"upload_to_mux\": true,\n \"delete_original_track\": true,\n \"track_name_suffix\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/edit-captions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "edit-captions" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-2a1e5a90-7340-4844-995a-b3fd0015af82" }, { "id": "843c615e-1016-4654-8b32-f558fe341911", "name": "Asset not found, no playback ID, or the requested text track is not ready", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"track_id\": \"\",\n \"auto_censor_profanity\": {\n \"detection_method\": \"llm\",\n \"mode\": \"blank\",\n \"always_censor\": [\n \"\",\n \"\"\n ],\n \"never_censor\": [\n \"\",\n \"\"\n ]\n },\n \"replacements\": [\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n },\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n }\n ],\n \"upload_to_mux\": true,\n \"delete_original_track\": true,\n \"track_name_suffix\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/edit-captions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "edit-captions" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-843c615e-1016-4654-8b32-f558fe341911" }, { "id": "84c537ad-89eb-48b5-a9e1-a645cace7e25", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"track_id\": \"\",\n \"auto_censor_profanity\": {\n \"detection_method\": \"llm\",\n \"mode\": \"blank\",\n \"always_censor\": [\n \"\",\n \"\"\n ],\n \"never_censor\": [\n \"\",\n \"\"\n ]\n },\n \"replacements\": [\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n },\n {\n \"find\": \"\",\n \"replace\": \"\",\n \"case_sensitive\": false\n }\n ],\n \"upload_to_mux\": true,\n \"delete_original_track\": true,\n \"track_name_suffix\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/edit-captions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "edit-captions" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-84c537ad-89eb-48b5-a9e1-a645cace7e25" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-2ac80905-5c94-4ce6-88f9-32b92db71a45" } ], "id": "6f396bd2-2384-4554-b0a7-c0b2806b223a", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-6f396bd2-2384-4554-b0a7-c0b2806b223a" }, { "name": "find-key-moments", "item": [ { "name": "{JOB_ID}", "item": [ { "name": "Get a 'find-Key-Moments' Job", "id": "8b4e0538-9e0d-4c25-a73c-c7daefeeeb67", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/find-key-moments/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "find-key-moments", ":JOB_ID" ], "variable": [ { "id": "ce874aab-625d-4f26-a066-0a842c6c7d46", "key": "JOB_ID", "value": "", "description": "(Required) " } ] }, "description": "Retrieves the current status and results of a 'find-key-moments' job. Jobs are automatically deleted after 30 days." }, "response": [ { "id": "9058c632-896c-40cc-bc07-6237e0f9313d", "name": "Current status for the requested job", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/find-key-moments/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "find-key-moments", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"units_consumed\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"workflow\": \"find-key-moments\",\n \"parameters\": {\n \"asset_id\": \"\",\n \"max_moments\": \"\",\n \"target_duration_ms\": {\n \"min\": \"\",\n \"max\": \"\"\n }\n },\n \"status\": \"errored\",\n \"passthrough\": \"\",\n \"outputs\": {\n \"moments\": [\n {\n \"start_ms\": \"\",\n \"end_ms\": \"\",\n \"cues\": [\n {\n \"start_ms\": \"\",\n \"end_ms\": \"\",\n \"text\": \"\"\n }\n ],\n \"overall_score\": \"\",\n \"title\": \"\",\n \"audible_narrative\": \"\",\n \"notable_audible_concepts\": [\n \"\"\n ],\n \"visual_narrative\": \"\",\n \"notable_visual_concepts\": [\n {\n \"concept\": \"\",\n \"score\": \"\",\n \"rationale\": \"\"\n }\n ]\n },\n {\n \"start_ms\": \"\",\n \"end_ms\": \"\",\n \"cues\": [\n {\n \"start_ms\": \"\",\n \"end_ms\": \"\",\n \"text\": \"\"\n }\n ],\n \"overall_score\": \"\",\n \"title\": \"\",\n \"audible_narrative\": \"\",\n \"notable_audible_concepts\": [\n \"\"\n ],\n \"visual_narrative\": \"\",\n \"notable_visual_concepts\": [\n {\n \"concept\": \"\",\n \"score\": \"\",\n \"rationale\": \"\"\n }\n ]\n }\n ]\n },\n \"errors\": [\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"resources\": {\n \"assets\": [\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n },\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-9058c632-896c-40cc-bc07-6237e0f9313d" }, { "id": "28534fe9-bf50-465e-b16d-f7d0ad753cc2", "name": "Robots is not enabled for this environment. Accept the Robots beta terms in the Mux Dashboard to enable access.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/find-key-moments/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "find-key-moments", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-28534fe9-bf50-465e-b16d-f7d0ad753cc2" }, { "id": "9e5a0e19-415e-4bab-91ab-c6be9b61ea8f", "name": "No job exists for the supplied id", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/find-key-moments/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "find-key-moments", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-9e5a0e19-415e-4bab-91ab-c6be9b61ea8f" }, { "id": "4f83c364-8c4b-46b3-ab8b-aca85c4c8fe5", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/find-key-moments/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "find-key-moments", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-4f83c364-8c4b-46b3-ab8b-aca85c4c8fe5" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-8b4e0538-9e0d-4c25-a73c-c7daefeeeb67" } ], "id": "8b7c9f34-77b8-46fd-bc5c-22a32ab9a92c", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-8b7c9f34-77b8-46fd-bc5c-22a32ab9a92c" }, { "name": "Create a 'find-Key-Moments' Job", "id": "b72d6f72-d1e4-4f1a-afa6-419b0304d4b4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"max_moments\": \"\",\n \"target_duration_ms\": {\n \"min\": \"\",\n \"max\": \"\"\n }\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/find-key-moments", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "find-key-moments" ] }, "description": "Creates a new job that uses AI to identify key moments in a Mux Video asset." }, "response": [ { "id": "913be965-228e-4d04-beda-af792fbda15f", "name": "Key moments job queued", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"max_moments\": \"\",\n \"target_duration_ms\": {\n \"min\": \"\",\n \"max\": \"\"\n }\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/find-key-moments", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "find-key-moments" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"units_consumed\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"workflow\": \"find-key-moments\",\n \"parameters\": {\n \"asset_id\": \"\",\n \"max_moments\": \"\",\n \"target_duration_ms\": {\n \"min\": \"\",\n \"max\": \"\"\n }\n },\n \"status\": \"errored\",\n \"passthrough\": \"\",\n \"outputs\": {\n \"moments\": [\n {\n \"start_ms\": \"\",\n \"end_ms\": \"\",\n \"cues\": [\n {\n \"start_ms\": \"\",\n \"end_ms\": \"\",\n \"text\": \"\"\n }\n ],\n \"overall_score\": \"\",\n \"title\": \"\",\n \"audible_narrative\": \"\",\n \"notable_audible_concepts\": [\n \"\"\n ],\n \"visual_narrative\": \"\",\n \"notable_visual_concepts\": [\n {\n \"concept\": \"\",\n \"score\": \"\",\n \"rationale\": \"\"\n }\n ]\n },\n {\n \"start_ms\": \"\",\n \"end_ms\": \"\",\n \"cues\": [\n {\n \"start_ms\": \"\",\n \"end_ms\": \"\",\n \"text\": \"\"\n }\n ],\n \"overall_score\": \"\",\n \"title\": \"\",\n \"audible_narrative\": \"\",\n \"notable_audible_concepts\": [\n \"\"\n ],\n \"visual_narrative\": \"\",\n \"notable_visual_concepts\": [\n {\n \"concept\": \"\",\n \"score\": \"\",\n \"rationale\": \"\"\n }\n ]\n }\n ]\n },\n \"errors\": [\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"resources\": {\n \"assets\": [\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n },\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-913be965-228e-4d04-beda-af792fbda15f" }, { "id": "d97f2c77-dccd-4c53-9d14-5635b7a8ca31", "name": "Missing Mux credentials for transcript access", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"max_moments\": \"\",\n \"target_duration_ms\": {\n \"min\": \"\",\n \"max\": \"\"\n }\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/find-key-moments", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "find-key-moments" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-d97f2c77-dccd-4c53-9d14-5635b7a8ca31" }, { "id": "e19d8782-e55c-4ab1-842c-a0980fe1f5e0", "name": "Robots is not enabled for this environment. Accept the Robots beta terms in the Mux Dashboard to enable access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"max_moments\": \"\",\n \"target_duration_ms\": {\n \"min\": \"\",\n \"max\": \"\"\n }\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/find-key-moments", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "find-key-moments" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e19d8782-e55c-4ab1-842c-a0980fe1f5e0" }, { "id": "2441e7d6-52fc-4660-bb2d-39c8c0e78711", "name": "Asset not found, missing playback ID, or no transcript", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"max_moments\": \"\",\n \"target_duration_ms\": {\n \"min\": \"\",\n \"max\": \"\"\n }\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/find-key-moments", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "find-key-moments" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-2441e7d6-52fc-4660-bb2d-39c8c0e78711" }, { "id": "9e7755f0-777e-4995-b064-0dd89c6c3baa", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"max_moments\": \"\",\n \"target_duration_ms\": {\n \"min\": \"\",\n \"max\": \"\"\n }\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/find-key-moments", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "find-key-moments" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-9e7755f0-777e-4995-b064-0dd89c6c3baa" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b72d6f72-d1e4-4f1a-afa6-419b0304d4b4" } ], "id": "6285c032-dcb6-400d-a26f-a7a8df348951", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-6285c032-dcb6-400d-a26f-a7a8df348951" }, { "name": "generate-chapters", "item": [ { "name": "{JOB_ID}", "item": [ { "name": "Get a 'generate-Chapters' Job", "id": "4ca52603-717b-4f47-9f73-553ebaef3db1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/generate-chapters/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "generate-chapters", ":JOB_ID" ], "variable": [ { "id": "0ddcee4c-952f-49d8-9d81-0fa64a24b6b6", "key": "JOB_ID", "value": "", "description": "(Required) " } ] }, "description": "Retrieves the current status and results of a 'generate-chapters' job. Jobs are automatically deleted after 30 days." }, "response": [ { "id": "889634bc-d664-4167-8436-4215f48c6de1", "name": "Current status for the requested job", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/generate-chapters/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "generate-chapters", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"units_consumed\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"workflow\": \"generate-chapters\",\n \"parameters\": {\n \"asset_id\": \"\",\n \"language_code\": \"\",\n \"output_language_code\": \"\",\n \"prompt_overrides\": {\n \"task\": \"\",\n \"output_format\": \"\",\n \"chapter_guidelines\": \"\",\n \"title_guidelines\": \"\"\n }\n },\n \"status\": \"processing\",\n \"passthrough\": \"\",\n \"outputs\": {\n \"chapters\": [\n {\n \"start_time\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"errors\": [\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"resources\": {\n \"assets\": [\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n },\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-889634bc-d664-4167-8436-4215f48c6de1" }, { "id": "ec7dc025-af08-4463-b2e9-fbd9c243020c", "name": "Robots is not enabled for this environment. Accept the Robots beta terms in the Mux Dashboard to enable access.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/generate-chapters/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "generate-chapters", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-ec7dc025-af08-4463-b2e9-fbd9c243020c" }, { "id": "4459a8aa-c0bb-4051-8b2a-3accbdb8cc92", "name": "No job exists for the supplied id", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/generate-chapters/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "generate-chapters", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-4459a8aa-c0bb-4051-8b2a-3accbdb8cc92" }, { "id": "a1cc5a40-38a8-4b80-8dd8-e35c1f3c52e0", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/generate-chapters/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "generate-chapters", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a1cc5a40-38a8-4b80-8dd8-e35c1f3c52e0" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-4ca52603-717b-4f47-9f73-553ebaef3db1" } ], "id": "1e263a5d-d133-40b0-ab23-6dbbb7e2bf2b", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-1e263a5d-d133-40b0-ab23-6dbbb7e2bf2b" }, { "name": "Create a 'generate-Chapters' Job", "id": "f61ef7cf-2250-443b-ad3a-0550dc99b319", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"language_code\": \"\",\n \"output_language_code\": \"\",\n \"prompt_overrides\": {\n \"task\": \"\",\n \"output_format\": \"\",\n \"chapter_guidelines\": \"\",\n \"title_guidelines\": \"\"\n }\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/generate-chapters", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "generate-chapters" ] }, "description": "Creates a new job that uses AI to generate chapters for a Mux Video asset." }, "response": [ { "id": "0358f370-066a-45be-8ac4-37ae8a0f41ea", "name": "Chapters job queued", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"language_code\": \"\",\n \"output_language_code\": \"\",\n \"prompt_overrides\": {\n \"task\": \"\",\n \"output_format\": \"\",\n \"chapter_guidelines\": \"\",\n \"title_guidelines\": \"\"\n }\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/generate-chapters", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "generate-chapters" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"units_consumed\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"workflow\": \"generate-chapters\",\n \"parameters\": {\n \"asset_id\": \"\",\n \"language_code\": \"\",\n \"output_language_code\": \"\",\n \"prompt_overrides\": {\n \"task\": \"\",\n \"output_format\": \"\",\n \"chapter_guidelines\": \"\",\n \"title_guidelines\": \"\"\n }\n },\n \"status\": \"processing\",\n \"passthrough\": \"\",\n \"outputs\": {\n \"chapters\": [\n {\n \"start_time\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"errors\": [\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"resources\": {\n \"assets\": [\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n },\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-0358f370-066a-45be-8ac4-37ae8a0f41ea" }, { "id": "416e1144-2d5f-45c7-923a-7691bd478015", "name": "Missing Mux credentials", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"language_code\": \"\",\n \"output_language_code\": \"\",\n \"prompt_overrides\": {\n \"task\": \"\",\n \"output_format\": \"\",\n \"chapter_guidelines\": \"\",\n \"title_guidelines\": \"\"\n }\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/generate-chapters", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "generate-chapters" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-416e1144-2d5f-45c7-923a-7691bd478015" }, { "id": "5d616170-5130-4183-a988-ab0c99e200da", "name": "Robots is not enabled for this environment. Accept the Robots beta terms in the Mux Dashboard to enable access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"language_code\": \"\",\n \"output_language_code\": \"\",\n \"prompt_overrides\": {\n \"task\": \"\",\n \"output_format\": \"\",\n \"chapter_guidelines\": \"\",\n \"title_guidelines\": \"\"\n }\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/generate-chapters", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "generate-chapters" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-5d616170-5130-4183-a988-ab0c99e200da" }, { "id": "2f6e72f0-24f2-472d-8197-8a3c1ac7262c", "name": "Asset not found, missing playback ID, or no transcript", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"language_code\": \"\",\n \"output_language_code\": \"\",\n \"prompt_overrides\": {\n \"task\": \"\",\n \"output_format\": \"\",\n \"chapter_guidelines\": \"\",\n \"title_guidelines\": \"\"\n }\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/generate-chapters", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "generate-chapters" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-2f6e72f0-24f2-472d-8197-8a3c1ac7262c" }, { "id": "1cc4aecc-2bf0-44d5-ab72-2394fddfb037", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"language_code\": \"\",\n \"output_language_code\": \"\",\n \"prompt_overrides\": {\n \"task\": \"\",\n \"output_format\": \"\",\n \"chapter_guidelines\": \"\",\n \"title_guidelines\": \"\"\n }\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/generate-chapters", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "generate-chapters" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-1cc4aecc-2bf0-44d5-ab72-2394fddfb037" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f61ef7cf-2250-443b-ad3a-0550dc99b319" } ], "id": "f3b83443-4861-4df5-bc1d-69996f86249c", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f3b83443-4861-4df5-bc1d-69996f86249c" }, { "name": "moderate", "item": [ { "name": "{JOB_ID}", "item": [ { "name": "Get a 'moderate' Job", "id": "9082c713-d5eb-44f8-9b81-17bbe7dc88a2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/moderate/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "moderate", ":JOB_ID" ], "variable": [ { "id": "001cd853-1014-4633-accc-0188177895ae", "key": "JOB_ID", "value": "", "description": "(Required) " } ] }, "description": "Retrieves the current status and results of a 'moderate' job. Jobs are automatically deleted after 30 days." }, "response": [ { "id": "cf0dbfb9-92d0-4cf3-b3e7-59f8fc9f482e", "name": "Current status for the requested job", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/moderate/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "moderate", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"units_consumed\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"workflow\": \"moderate\",\n \"parameters\": {\n \"asset_id\": \"\",\n \"language_code\": \"en\",\n \"thresholds\": {\n \"sexual\": 0.7,\n \"violence\": 0.8\n },\n \"sampling_interval\": \"\",\n \"max_samples\": \"\"\n },\n \"status\": \"cancelled\",\n \"passthrough\": \"\",\n \"outputs\": {\n \"thumbnail_scores\": [\n {\n \"sexual\": \"\",\n \"violence\": \"\",\n \"time\": \"\"\n },\n {\n \"sexual\": \"\",\n \"violence\": \"\",\n \"time\": \"\"\n }\n ],\n \"max_scores\": {\n \"sexual\": \"\",\n \"violence\": \"\"\n },\n \"exceeds_threshold\": \"\"\n },\n \"errors\": [\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"resources\": {\n \"assets\": [\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n },\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-cf0dbfb9-92d0-4cf3-b3e7-59f8fc9f482e" }, { "id": "61ae926f-1309-4e85-bc74-18c820c98ee6", "name": "Robots is not enabled for this environment. Accept the Robots beta terms in the Mux Dashboard to enable access.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/moderate/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "moderate", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-61ae926f-1309-4e85-bc74-18c820c98ee6" }, { "id": "a9eb0951-3df4-4e73-a165-1304df550dbd", "name": "No job exists for the supplied id", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/moderate/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "moderate", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a9eb0951-3df4-4e73-a165-1304df550dbd" }, { "id": "9d98b2f3-00e3-4a2e-b8d6-7cc367588c4a", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/moderate/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "moderate", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-9d98b2f3-00e3-4a2e-b8d6-7cc367588c4a" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-9082c713-d5eb-44f8-9b81-17bbe7dc88a2" } ], "id": "68780fe5-2206-4021-9d97-d2a50bb63e35", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-68780fe5-2206-4021-9d97-d2a50bb63e35" }, { "name": "Create a 'moderate' Job", "id": "19f05409-cd78-4046-b907-9437adca1cc7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"language_code\": \"en\",\n \"thresholds\": {\n \"sexual\": 0.7,\n \"violence\": 0.8\n },\n \"sampling_interval\": \"\",\n \"max_samples\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/moderate", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "moderate" ] }, "description": "Creates a new job that uses AI to analyze a Mux Video asset for inappropriate content." }, "response": [ { "id": "006cc39f-9dfb-48ce-b782-3d380db2fd40", "name": "Moderation job queued", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"language_code\": \"en\",\n \"thresholds\": {\n \"sexual\": 0.7,\n \"violence\": 0.8\n },\n \"sampling_interval\": \"\",\n \"max_samples\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/moderate", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "moderate" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"units_consumed\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"workflow\": \"moderate\",\n \"parameters\": {\n \"asset_id\": \"\",\n \"language_code\": \"en\",\n \"thresholds\": {\n \"sexual\": 0.7,\n \"violence\": 0.8\n },\n \"sampling_interval\": \"\",\n \"max_samples\": \"\"\n },\n \"status\": \"cancelled\",\n \"passthrough\": \"\",\n \"outputs\": {\n \"thumbnail_scores\": [\n {\n \"sexual\": \"\",\n \"violence\": \"\",\n \"time\": \"\"\n },\n {\n \"sexual\": \"\",\n \"violence\": \"\",\n \"time\": \"\"\n }\n ],\n \"max_scores\": {\n \"sexual\": \"\",\n \"violence\": \"\"\n },\n \"exceeds_threshold\": \"\"\n },\n \"errors\": [\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"resources\": {\n \"assets\": [\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n },\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-006cc39f-9dfb-48ce-b782-3d380db2fd40" }, { "id": "3f6ebec9-3ad8-4fb1-a590-21085e9f08aa", "name": "Missing Mux credentials", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"language_code\": \"en\",\n \"thresholds\": {\n \"sexual\": 0.7,\n \"violence\": 0.8\n },\n \"sampling_interval\": \"\",\n \"max_samples\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/moderate", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "moderate" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-3f6ebec9-3ad8-4fb1-a590-21085e9f08aa" }, { "id": "8776dcc3-f1e1-4899-8d37-33360bb02b43", "name": "Robots is not enabled for this environment. Accept the Robots beta terms in the Mux Dashboard to enable access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"language_code\": \"en\",\n \"thresholds\": {\n \"sexual\": 0.7,\n \"violence\": 0.8\n },\n \"sampling_interval\": \"\",\n \"max_samples\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/moderate", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "moderate" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-8776dcc3-f1e1-4899-8d37-33360bb02b43" }, { "id": "906b04c0-1c55-4028-b274-8a79c19b3700", "name": "Asset not found or missing playback ID", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"language_code\": \"en\",\n \"thresholds\": {\n \"sexual\": 0.7,\n \"violence\": 0.8\n },\n \"sampling_interval\": \"\",\n \"max_samples\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/moderate", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "moderate" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-906b04c0-1c55-4028-b274-8a79c19b3700" }, { "id": "706b362f-34f4-4800-a174-3d11b8f2b851", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"language_code\": \"en\",\n \"thresholds\": {\n \"sexual\": 0.7,\n \"violence\": 0.8\n },\n \"sampling_interval\": \"\",\n \"max_samples\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/moderate", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "moderate" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-706b362f-34f4-4800-a174-3d11b8f2b851" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-19f05409-cd78-4046-b907-9437adca1cc7" } ], "id": "4315e235-2f39-401f-a435-2e9b68c99376", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-4315e235-2f39-401f-a435-2e9b68c99376" }, { "name": "summarize", "item": [ { "name": "{JOB_ID}", "item": [ { "name": "Get a 'summarize' Job", "id": "8dbf4be4-ce51-4d27-a074-505995a451fb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/summarize/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "summarize", ":JOB_ID" ], "variable": [ { "id": "ac2f02a4-7b00-488e-8a95-898c068cf5ec", "key": "JOB_ID", "value": "", "description": "(Required) " } ] }, "description": "Retrieves the current status and results of a 'summarize' job. Jobs are automatically deleted after 30 days." }, "response": [ { "id": "9fe964af-5681-4d80-99c0-3c0fcb5b012b", "name": "Current status for the requested job", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/summarize/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "summarize", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"units_consumed\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"workflow\": \"summarize\",\n \"parameters\": {\n \"asset_id\": \"\",\n \"tone\": \"playful\",\n \"prompt_overrides\": {\n \"task\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"keywords\": \"\",\n \"quality_guidelines\": \"\"\n },\n \"title_length\": \"\",\n \"description_length\": \"\",\n \"tag_count\": \"\",\n \"language_code\": \"\",\n \"output_language_code\": \"\"\n },\n \"status\": \"pending\",\n \"passthrough\": \"\",\n \"outputs\": {\n \"title\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n \"errors\": [\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"resources\": {\n \"assets\": [\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n },\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-9fe964af-5681-4d80-99c0-3c0fcb5b012b" }, { "id": "72588e0e-ee76-4c82-967b-831f0b61e5cd", "name": "Robots is not enabled for this environment. Accept the Robots beta terms in the Mux Dashboard to enable access.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/summarize/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "summarize", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-72588e0e-ee76-4c82-967b-831f0b61e5cd" }, { "id": "948b3f58-6589-42dc-8866-db39177ebd01", "name": "No job exists for the supplied id", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/summarize/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "summarize", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-948b3f58-6589-42dc-8866-db39177ebd01" }, { "id": "e85783f4-cc81-4c15-9dd1-079e881d9453", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/summarize/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "summarize", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e85783f4-cc81-4c15-9dd1-079e881d9453" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-8dbf4be4-ce51-4d27-a074-505995a451fb" } ], "id": "55b3754e-08f9-469c-8fcf-cce3d12b76d3", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-55b3754e-08f9-469c-8fcf-cce3d12b76d3" }, { "name": "Create a 'summarize' Job", "id": "ed22fcba-93c0-40e2-b9f0-4c629ae80872", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"tone\": \"playful\",\n \"prompt_overrides\": {\n \"task\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"keywords\": \"\",\n \"quality_guidelines\": \"\"\n },\n \"title_length\": \"\",\n \"description_length\": \"\",\n \"tag_count\": \"\",\n \"language_code\": \"\",\n \"output_language_code\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/summarize", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "summarize" ] }, "description": "Creates a new job that uses AI to generate a title, description, and tags for a Mux Video asset." }, "response": [ { "id": "9255513b-5860-4f8c-8999-e0171fe95303", "name": "Summarize job queued", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"tone\": \"playful\",\n \"prompt_overrides\": {\n \"task\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"keywords\": \"\",\n \"quality_guidelines\": \"\"\n },\n \"title_length\": \"\",\n \"description_length\": \"\",\n \"tag_count\": \"\",\n \"language_code\": \"\",\n \"output_language_code\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/summarize", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "summarize" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"units_consumed\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"workflow\": \"summarize\",\n \"parameters\": {\n \"asset_id\": \"\",\n \"tone\": \"playful\",\n \"prompt_overrides\": {\n \"task\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"keywords\": \"\",\n \"quality_guidelines\": \"\"\n },\n \"title_length\": \"\",\n \"description_length\": \"\",\n \"tag_count\": \"\",\n \"language_code\": \"\",\n \"output_language_code\": \"\"\n },\n \"status\": \"pending\",\n \"passthrough\": \"\",\n \"outputs\": {\n \"title\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n \"errors\": [\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"resources\": {\n \"assets\": [\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n },\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-9255513b-5860-4f8c-8999-e0171fe95303" }, { "id": "6eed71d0-b071-48ff-ac19-589c8a47a6a2", "name": "Missing Mux credentials", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"tone\": \"playful\",\n \"prompt_overrides\": {\n \"task\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"keywords\": \"\",\n \"quality_guidelines\": \"\"\n },\n \"title_length\": \"\",\n \"description_length\": \"\",\n \"tag_count\": \"\",\n \"language_code\": \"\",\n \"output_language_code\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/summarize", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "summarize" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-6eed71d0-b071-48ff-ac19-589c8a47a6a2" }, { "id": "e61cd25b-3723-4fc7-8949-3ececf57f302", "name": "Robots is not enabled for this environment. Accept the Robots beta terms in the Mux Dashboard to enable access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"tone\": \"playful\",\n \"prompt_overrides\": {\n \"task\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"keywords\": \"\",\n \"quality_guidelines\": \"\"\n },\n \"title_length\": \"\",\n \"description_length\": \"\",\n \"tag_count\": \"\",\n \"language_code\": \"\",\n \"output_language_code\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/summarize", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "summarize" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e61cd25b-3723-4fc7-8949-3ececf57f302" }, { "id": "2369fd69-247d-46ac-abb9-e2bbd384778b", "name": "Asset not found or missing playback ID", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"tone\": \"playful\",\n \"prompt_overrides\": {\n \"task\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"keywords\": \"\",\n \"quality_guidelines\": \"\"\n },\n \"title_length\": \"\",\n \"description_length\": \"\",\n \"tag_count\": \"\",\n \"language_code\": \"\",\n \"output_language_code\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/summarize", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "summarize" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-2369fd69-247d-46ac-abb9-e2bbd384778b" }, { "id": "f482bfc5-4f0e-481f-a770-29f58acfeebd", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"tone\": \"playful\",\n \"prompt_overrides\": {\n \"task\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"keywords\": \"\",\n \"quality_guidelines\": \"\"\n },\n \"title_length\": \"\",\n \"description_length\": \"\",\n \"tag_count\": \"\",\n \"language_code\": \"\",\n \"output_language_code\": \"\"\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/summarize", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "summarize" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f482bfc5-4f0e-481f-a770-29f58acfeebd" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-ed22fcba-93c0-40e2-b9f0-4c629ae80872" } ], "id": "2acb7ca6-f420-47ba-acef-171403bf5970", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-2acb7ca6-f420-47ba-acef-171403bf5970" }, { "name": "translate-captions", "item": [ { "name": "{JOB_ID}", "item": [ { "name": "Get a 'translate-Captions' Job", "id": "5307223f-70b8-4d7f-ad67-24e13a46d2a8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/translate-captions/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "translate-captions", ":JOB_ID" ], "variable": [ { "id": "b93bb516-31ef-4d3e-bd23-cba22ae065d8", "key": "JOB_ID", "value": "", "description": "(Required) " } ] }, "description": "Retrieves the current status and results of a 'translate-captions' job. Jobs are automatically deleted after 30 days." }, "response": [ { "id": "ddb6c10c-87c9-4eb9-9ba1-ca02eb969285", "name": "Current status for the requested job", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/translate-captions/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "translate-captions", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"units_consumed\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"workflow\": \"translate-captions\",\n \"parameters\": {\n \"asset_id\": \"\",\n \"track_id\": \"\",\n \"to_language_code\": \"\",\n \"upload_to_mux\": true\n },\n \"status\": \"errored\",\n \"passthrough\": \"\",\n \"outputs\": {\n \"track_id\": \"\",\n \"uploaded_track_id\": \"\",\n \"temporary_vtt_url\": \"\"\n },\n \"errors\": [\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"resources\": {\n \"assets\": [\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n },\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-ddb6c10c-87c9-4eb9-9ba1-ca02eb969285" }, { "id": "3b3cdc77-1dbd-4bd4-a40f-1624ae1654c4", "name": "Robots is not enabled for this environment. Accept the Robots beta terms in the Mux Dashboard to enable access.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/translate-captions/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "translate-captions", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-3b3cdc77-1dbd-4bd4-a40f-1624ae1654c4" }, { "id": "56cd39aa-0ab5-48d8-918f-1dbdd00e6229", "name": "No job exists for the supplied id", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/translate-captions/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "translate-captions", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-56cd39aa-0ab5-48d8-918f-1dbdd00e6229" }, { "id": "7eda8a60-a125-4ca4-8a5a-c1e4961fc4bf", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs/translate-captions/:JOB_ID", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "translate-captions", ":JOB_ID" ], "variable": [ { "key": "JOB_ID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-7eda8a60-a125-4ca4-8a5a-c1e4961fc4bf" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-5307223f-70b8-4d7f-ad67-24e13a46d2a8" } ], "id": "f13ad263-30a0-4029-8a7e-be52283c232e", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f13ad263-30a0-4029-8a7e-be52283c232e" }, { "name": "Create a 'translate-Captions' Job", "id": "1b570dd2-f2e2-4c21-b52d-70fcee35131b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"track_id\": \"\",\n \"to_language_code\": \"\",\n \"upload_to_mux\": true\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/translate-captions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "translate-captions" ] }, "description": "Creates a new job that translates captions on a Mux Video asset from one language to another." }, "response": [ { "id": "878c0d20-a0ad-4cd5-b443-e4b73ad34a60", "name": "Caption translation job queued", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"track_id\": \"\",\n \"to_language_code\": \"\",\n \"upload_to_mux\": true\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/translate-captions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "translate-captions" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"units_consumed\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"workflow\": \"translate-captions\",\n \"parameters\": {\n \"asset_id\": \"\",\n \"track_id\": \"\",\n \"to_language_code\": \"\",\n \"upload_to_mux\": true\n },\n \"status\": \"errored\",\n \"passthrough\": \"\",\n \"outputs\": {\n \"track_id\": \"\",\n \"uploaded_track_id\": \"\",\n \"temporary_vtt_url\": \"\"\n },\n \"errors\": [\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"resources\": {\n \"assets\": [\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n },\n {\n \"id\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"title\": \"\",\n \"creator_id\": \"\",\n \"external_id\": \"\"\n },\n \"passthrough\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-878c0d20-a0ad-4cd5-b443-e4b73ad34a60" }, { "id": "c22a174c-2cde-4fad-a2d3-8a7bd5e373db", "name": "Missing Mux credentials", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"track_id\": \"\",\n \"to_language_code\": \"\",\n \"upload_to_mux\": true\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/translate-captions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "translate-captions" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-c22a174c-2cde-4fad-a2d3-8a7bd5e373db" }, { "id": "ce874097-3b8a-4021-a52b-965b01e8292a", "name": "Robots is not enabled for this environment. Accept the Robots beta terms in the Mux Dashboard to enable access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"track_id\": \"\",\n \"to_language_code\": \"\",\n \"upload_to_mux\": true\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/translate-captions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "translate-captions" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-ce874097-3b8a-4021-a52b-965b01e8292a" }, { "id": "3fefa051-1f6d-4a48-a153-911dc7b6c6ce", "name": "Asset not found, missing playback ID, or no ready text track matching the provided track ID", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"track_id\": \"\",\n \"to_language_code\": \"\",\n \"upload_to_mux\": true\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/translate-captions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "translate-captions" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-3fefa051-1f6d-4a48-a153-911dc7b6c6ce" }, { "id": "393d02f6-6114-49a9-a7b8-6e1f2cced786", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"asset_id\": \"\",\n \"track_id\": \"\",\n \"to_language_code\": \"\",\n \"upload_to_mux\": true\n },\n \"passthrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://api.mux.com/robots/v0/jobs/translate-captions", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs", "translate-captions" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-393d02f6-6114-49a9-a7b8-6e1f2cced786" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-1b570dd2-f2e2-4c21-b52d-70fcee35131b" } ], "id": "c820b279-e8d1-43a5-9ece-b14e2993ab35", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-c820b279-e8d1-43a5-9ece-b14e2993ab35" }, { "name": "List Jobs", "id": "ea8944a9-20f6-4742-bc16-cda459872f18", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs?workflow=edit-captions&status=pending&asset_id=&limit=25&page=1", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs" ], "query": [ { "description": "Filter by workflow name", "key": "workflow", "value": "edit-captions" }, { "description": "Filter by job status", "key": "status", "value": "pending" }, { "description": "Filter by Mux asset ID", "key": "asset_id", "value": "" }, { "description": "Maximum number of jobs to return (default 25, max 100)", "key": "limit", "value": "25" }, { "description": "Page number (default 1)", "key": "page", "value": "1" } ] }, "description": "Returns a paginated list of Robots jobs, with optional filters for workflow, status, and asset_id. Jobs are automatically deleted after 30 days." }, "response": [ { "id": "39c90b48-96d4-4a87-9585-112b83c07f7c", "name": "List of jobs", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs?workflow=edit-captions&status=pending&asset_id=&limit=25&page=1", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs" ], "query": [ { "description": "Filter by workflow name", "key": "workflow", "value": "edit-captions" }, { "description": "Filter by job status", "key": "status", "value": "pending" }, { "description": "Filter by Mux asset ID", "key": "asset_id", "value": "" }, { "description": "Maximum number of jobs to return (default 25, max 100)", "key": "limit", "value": "25" }, { "description": "Page number (default 1)", "key": "page", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"workflow\": \"summarize\",\n \"status\": \"cancelled\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"workflow\": \"find-key-moments\",\n \"status\": \"completed\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"total_row_count\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-39c90b48-96d4-4a87-9585-112b83c07f7c" }, { "id": "c00e1b1d-b112-4d83-9d9c-d1f0ee78cd73", "name": "Robots is not enabled for this environment. Accept the Robots beta terms in the Mux Dashboard to enable access.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs?workflow=edit-captions&status=pending&asset_id=&limit=25&page=1", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs" ], "query": [ { "description": "Filter by workflow name", "key": "workflow", "value": "edit-captions" }, { "description": "Filter by job status", "key": "status", "value": "pending" }, { "description": "Filter by Mux asset ID", "key": "asset_id", "value": "" }, { "description": "Maximum number of jobs to return (default 25, max 100)", "key": "limit", "value": "25" }, { "description": "Page number (default 1)", "key": "page", "value": "1" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-c00e1b1d-b112-4d83-9d9c-d1f0ee78cd73" }, { "id": "53822605-9a4a-4b7b-80e7-6749753cf819", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "https://api.mux.com/robots/v0/jobs?workflow=edit-captions&status=pending&asset_id=&limit=25&page=1", "protocol": "https", "host": [ "api", "mux", "com" ], "path": [ "robots", "v0", "jobs" ], "query": [ { "description": "Filter by workflow name", "key": "workflow", "value": "edit-captions" }, { "description": "Filter by job status", "key": "status", "value": "pending" }, { "description": "Filter by Mux asset ID", "key": "asset_id", "value": "" }, { "description": "Maximum number of jobs to return (default 25, max 100)", "key": "limit", "value": "25" }, { "description": "Page number (default 1)", "key": "page", "value": "1" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-53822605-9a4a-4b7b-80e7-6749753cf819" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-ea8944a9-20f6-4742-bc16-cda459872f18" } ], "id": "d0a62576-ba5f-464b-8f9a-4905bfe599fd", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-d0a62576-ba5f-464b-8f9a-4905bfe599fd" } ], "id": "9a3ae726-a4a2-4fcc-ad7f-07b40a7d0782", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-9a3ae726-a4a2-4fcc-ad7f-07b40a7d0782" } ], "id": "0a08531d-533d-4286-8acd-b420f89e6eb2", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-0a08531d-533d-4286-8acd-b420f89e6eb2" }, { "name": "{PLAYBACK_ID}", "item": [ { "name": "thumbnail.{EXTENSION}", "item": [ { "name": "Retrieve a Video Thumbnail", "id": "e50fdf59-5d92-46ca-8b7b-b63029136dbb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "image/jpeg" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/thumbnail.{{EXTENSION}}?TOKEN=&time=&width=&height=&rotate=180&fit_mode=pad&flip_v=&flip_h=&program_time=&latest=", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "thumbnail.{{EXTENSION}}" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "The time (in seconds) of the video timeline where the image should be pulled. Defaults to the middle of the original video.", "key": "time", "value": "" }, { "description": "The width of the thumbnail (in pixels). Defaults to the width of the original video.", "key": "width", "value": "" }, { "description": "The height of the thumbnail (in pixels). Defaults to the height of the original video.", "key": "height", "value": "" }, { "description": "Rotate the image clockwise by the given number of degrees.", "key": "rotate", "value": "180" }, { "description": "How to fit a thumbnail within the specified width + height.", "key": "fit_mode", "value": "pad" }, { "description": "Flip the image top-bottom after performing all other transformations.", "key": "flip_v", "value": "" }, { "description": "Flip the image left-right after performing all other transformations.", "key": "flip_h", "value": "" }, { "description": "Set the time of the thumbnail for an asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_time", "value": "" }, { "description": "When set to `true`, pulls the latest thumbnail from the playback ID of an ongoing live stream. Can only be used with live streams. Can be used to build moderation and classification workflows, [see documentation for more details](https://mux.com/docs/guides/get-images-from-a-video#getting-the-latest-thumbnail-from-a-live-stream).", "key": "latest", "value": "" } ], "variable": [ { "id": "73237a9b-f337-426f-8dad-a456cfe4fb87", "key": "PLAYBACK_ID", "value": "", "description": "(Required) The asset or live stream's playback ID." } ] }, "description": "[Fetch a thumbnail image from a video](https://docs.mux.com/guides/get-images-from-a-video) at a specified time with optional transformations." }, "response": [ { "id": "da211846-43d4-401e-94ce-53d9593efa81", "name": "Thumbnail image retrieved successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "image/jpeg" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/thumbnail.{{EXTENSION}}?TOKEN=&time=&width=&height=&rotate=180&fit_mode=pad&flip_v=&flip_h=&program_time=&latest=", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "thumbnail.{{EXTENSION}}" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "The time (in seconds) of the video timeline where the image should be pulled. Defaults to the middle of the original video.", "key": "time", "value": "" }, { "description": "The width of the thumbnail (in pixels). Defaults to the width of the original video.", "key": "width", "value": "" }, { "description": "The height of the thumbnail (in pixels). Defaults to the height of the original video.", "key": "height", "value": "" }, { "description": "Rotate the image clockwise by the given number of degrees.", "key": "rotate", "value": "180" }, { "description": "How to fit a thumbnail within the specified width + height.", "key": "fit_mode", "value": "pad" }, { "description": "Flip the image top-bottom after performing all other transformations.", "key": "flip_v", "value": "" }, { "description": "Flip the image left-right after performing all other transformations.", "key": "flip_h", "value": "" }, { "description": "Set the time of the thumbnail for an asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_time", "value": "" }, { "description": "When set to `true`, pulls the latest thumbnail from the playback ID of an ongoing live stream. Can only be used with live streams. Can be used to build moderation and classification workflows, [see documentation for more details](https://mux.com/docs/guides/get-images-from-a-video#getting-the-latest-thumbnail-from-a-live-stream).", "key": "latest", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "image/jpeg" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-da211846-43d4-401e-94ce-53d9593efa81" }, { "id": "15f5995a-ed8f-413c-a880-556544215df5", "name": "Bad request due to invalid parameters.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/thumbnail.{{EXTENSION}}?TOKEN=&time=&width=&height=&rotate=180&fit_mode=pad&flip_v=&flip_h=&program_time=&latest=", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "thumbnail.{{EXTENSION}}" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "The time (in seconds) of the video timeline where the image should be pulled. Defaults to the middle of the original video.", "key": "time", "value": "" }, { "description": "The width of the thumbnail (in pixels). Defaults to the width of the original video.", "key": "width", "value": "" }, { "description": "The height of the thumbnail (in pixels). Defaults to the height of the original video.", "key": "height", "value": "" }, { "description": "Rotate the image clockwise by the given number of degrees.", "key": "rotate", "value": "180" }, { "description": "How to fit a thumbnail within the specified width + height.", "key": "fit_mode", "value": "pad" }, { "description": "Flip the image top-bottom after performing all other transformations.", "key": "flip_v", "value": "" }, { "description": "Flip the image left-right after performing all other transformations.", "key": "flip_h", "value": "" }, { "description": "Set the time of the thumbnail for an asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_time", "value": "" }, { "description": "When set to `true`, pulls the latest thumbnail from the playback ID of an ongoing live stream. Can only be used with live streams. Can be used to build moderation and classification workflows, [see documentation for more details](https://mux.com/docs/guides/get-images-from-a-video#getting-the-latest-thumbnail-from-a-live-stream).", "key": "latest", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-15f5995a-ed8f-413c-a880-556544215df5" }, { "id": "1600103b-d19e-4e36-b1ca-128cfd5ca558", "name": "Video asset not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/thumbnail.{{EXTENSION}}?TOKEN=&time=&width=&height=&rotate=180&fit_mode=pad&flip_v=&flip_h=&program_time=&latest=", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "thumbnail.{{EXTENSION}}" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "The time (in seconds) of the video timeline where the image should be pulled. Defaults to the middle of the original video.", "key": "time", "value": "" }, { "description": "The width of the thumbnail (in pixels). Defaults to the width of the original video.", "key": "width", "value": "" }, { "description": "The height of the thumbnail (in pixels). Defaults to the height of the original video.", "key": "height", "value": "" }, { "description": "Rotate the image clockwise by the given number of degrees.", "key": "rotate", "value": "180" }, { "description": "How to fit a thumbnail within the specified width + height.", "key": "fit_mode", "value": "pad" }, { "description": "Flip the image top-bottom after performing all other transformations.", "key": "flip_v", "value": "" }, { "description": "Flip the image left-right after performing all other transformations.", "key": "flip_h", "value": "" }, { "description": "Set the time of the thumbnail for an asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_time", "value": "" }, { "description": "When set to `true`, pulls the latest thumbnail from the playback ID of an ongoing live stream. Can only be used with live streams. Can be used to build moderation and classification workflows, [see documentation for more details](https://mux.com/docs/guides/get-images-from-a-video#getting-the-latest-thumbnail-from-a-live-stream).", "key": "latest", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-1600103b-d19e-4e36-b1ca-128cfd5ca558" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e50fdf59-5d92-46ca-8b7b-b63029136dbb" } ], "id": "af314409-9b73-4716-8186-257b3aa234ed", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-af314409-9b73-4716-8186-257b3aa234ed" }, { "name": "animated.{EXTENSION}", "item": [ { "name": "Retrieve an Animated Image from a Video", "id": "14a5e1d1-01d6-4548-906c-58ace67162e9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "image/gif" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/animated.{{EXTENSION}}?TOKEN=&start=&end=&width=&height=&fps=", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "animated.{{EXTENSION}}" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "The time (in seconds) of the video timeline where the animated GIF should begin. Defaults to 0.", "key": "start", "value": "" }, { "description": "The time (in seconds) of the video timeline where the GIF ends. Defaults to 5 seconds after the start. Maximum total duration of GIF is limited to 10 seconds; minimum total duration of GIF is 250ms.", "key": "end", "value": "" }, { "description": "The width in pixels of the animated GIF. Default is 320px, or if height is provided, the width is determined by preserving aspect ratio with the height. Max width is 640px.", "key": "width", "value": "" }, { "description": "The height in pixels of the animated GIF. The default height is determined by preserving aspect ratio with the width provided. Maximum height is 640px.", "key": "height", "value": "" }, { "description": "The frame rate of the generated GIF. Defaults to 15 fps. Max 30 fps.", "key": "fps", "value": "" } ], "variable": [ { "id": "3e0896c2-f940-4922-b3ed-296cf2dee6fa", "key": "PLAYBACK_ID", "value": "", "description": "(Required) The asset or live stream's playback ID." } ] }, "description": "[Fetch an animated GIF or WebP image](https://docs.mux.com/guides/get-images-from-a-video#get-an-animated-gif-from-a-video) from a video segment with optional transformations." }, "response": [ { "id": "b956a8b2-506a-4249-ab3b-a5ca698481b3", "name": "Animated image retrieved successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "image/gif" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/animated.{{EXTENSION}}?TOKEN=&start=&end=&width=&height=&fps=", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "animated.{{EXTENSION}}" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "The time (in seconds) of the video timeline where the animated GIF should begin. Defaults to 0.", "key": "start", "value": "" }, { "description": "The time (in seconds) of the video timeline where the GIF ends. Defaults to 5 seconds after the start. Maximum total duration of GIF is limited to 10 seconds; minimum total duration of GIF is 250ms.", "key": "end", "value": "" }, { "description": "The width in pixels of the animated GIF. Default is 320px, or if height is provided, the width is determined by preserving aspect ratio with the height. Max width is 640px.", "key": "width", "value": "" }, { "description": "The height in pixels of the animated GIF. The default height is determined by preserving aspect ratio with the width provided. Maximum height is 640px.", "key": "height", "value": "" }, { "description": "The frame rate of the generated GIF. Defaults to 15 fps. Max 30 fps.", "key": "fps", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "image/gif" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b956a8b2-506a-4249-ab3b-a5ca698481b3" }, { "id": "f3826fcf-21b2-492f-9c3e-a2f95a0293df", "name": "Bad request due to invalid parameters.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/animated.{{EXTENSION}}?TOKEN=&start=&end=&width=&height=&fps=", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "animated.{{EXTENSION}}" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "The time (in seconds) of the video timeline where the animated GIF should begin. Defaults to 0.", "key": "start", "value": "" }, { "description": "The time (in seconds) of the video timeline where the GIF ends. Defaults to 5 seconds after the start. Maximum total duration of GIF is limited to 10 seconds; minimum total duration of GIF is 250ms.", "key": "end", "value": "" }, { "description": "The width in pixels of the animated GIF. Default is 320px, or if height is provided, the width is determined by preserving aspect ratio with the height. Max width is 640px.", "key": "width", "value": "" }, { "description": "The height in pixels of the animated GIF. The default height is determined by preserving aspect ratio with the width provided. Maximum height is 640px.", "key": "height", "value": "" }, { "description": "The frame rate of the generated GIF. Defaults to 15 fps. Max 30 fps.", "key": "fps", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f3826fcf-21b2-492f-9c3e-a2f95a0293df" }, { "id": "bf738c2a-fc1d-4f57-955c-0327069ab166", "name": "Video asset not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/animated.{{EXTENSION}}?TOKEN=&start=&end=&width=&height=&fps=", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "animated.{{EXTENSION}}" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "The time (in seconds) of the video timeline where the animated GIF should begin. Defaults to 0.", "key": "start", "value": "" }, { "description": "The time (in seconds) of the video timeline where the GIF ends. Defaults to 5 seconds after the start. Maximum total duration of GIF is limited to 10 seconds; minimum total duration of GIF is 250ms.", "key": "end", "value": "" }, { "description": "The width in pixels of the animated GIF. Default is 320px, or if height is provided, the width is determined by preserving aspect ratio with the height. Max width is 640px.", "key": "width", "value": "" }, { "description": "The height in pixels of the animated GIF. The default height is determined by preserving aspect ratio with the width provided. Maximum height is 640px.", "key": "height", "value": "" }, { "description": "The frame rate of the generated GIF. Defaults to 15 fps. Max 30 fps.", "key": "fps", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-bf738c2a-fc1d-4f57-955c-0327069ab166" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-14a5e1d1-01d6-4548-906c-58ace67162e9" } ], "id": "99d1a0fa-b419-4542-ac3e-6f9a6d7b9dcc", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-99d1a0fa-b419-4542-ac3e-6f9a6d7b9dcc" }, { "name": "storyboard.{EXTENSION}", "item": [ { "name": "Retrieve a Storyboard Image for Timeline Hover Previews", "id": "8f73a717-3425-4f09-b35c-49d81231a87d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "image/jpeg" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/storyboard.{{EXTENSION}}?TOKEN=&program_start_time=&program_end_time=&asset_start_time=&asset_end_time=", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "storyboard.{{EXTENSION}}" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_start_time", "value": "" }, { "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_end_time", "value": "" }, { "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_start_time", "value": "" }, { "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_end_time", "value": "" } ], "variable": [ { "id": "bac7c1a5-b7a0-4988-b030-805f391cf2a6", "key": "PLAYBACK_ID", "value": "", "description": "(Required) The asset or live stream's playback ID." } ] }, "description": "Fetch a storyboard image composed of multiple thumbnails for use in [timeline hover previews](https://docs.mux.com/guides/create-timeline-hover-previews)." }, "response": [ { "id": "7fe2e5b1-5b97-4548-97b7-1726b5bb87a0", "name": "Storyboard image retrieved successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "image/jpeg" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/storyboard.{{EXTENSION}}?TOKEN=&program_start_time=&program_end_time=&asset_start_time=&asset_end_time=", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "storyboard.{{EXTENSION}}" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_start_time", "value": "" }, { "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_end_time", "value": "" }, { "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_start_time", "value": "" }, { "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_end_time", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "image/jpeg" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-7fe2e5b1-5b97-4548-97b7-1726b5bb87a0" }, { "id": "9f40253f-62e2-47bc-9a69-e900a60a88b5", "name": "Bad request due to invalid parameters.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/storyboard.{{EXTENSION}}?TOKEN=&program_start_time=&program_end_time=&asset_start_time=&asset_end_time=", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "storyboard.{{EXTENSION}}" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_start_time", "value": "" }, { "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_end_time", "value": "" }, { "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_start_time", "value": "" }, { "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_end_time", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-9f40253f-62e2-47bc-9a69-e900a60a88b5" }, { "id": "1c85a694-687e-45b4-8cbc-49d809e0d25a", "name": "Video asset not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/storyboard.{{EXTENSION}}?TOKEN=&program_start_time=&program_end_time=&asset_start_time=&asset_end_time=", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "storyboard.{{EXTENSION}}" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_start_time", "value": "" }, { "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_end_time", "value": "" }, { "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_start_time", "value": "" }, { "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_end_time", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-1c85a694-687e-45b4-8cbc-49d809e0d25a" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-8f73a717-3425-4f09-b35c-49d81231a87d" } ], "id": "1a888b06-3457-41ea-bd88-fe46b2c4900e", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-1a888b06-3457-41ea-bd88-fe46b2c4900e" }, { "name": "storyboard.vtt", "item": [ { "name": "Retrieve Storyboard Metadata in WebVTT Format", "id": "9ab80444-b896-410c-82a0-37cedaa777d2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "text/vtt" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/storyboard.vtt?TOKEN=&program_start_time=&program_end_time=&asset_start_time=&asset_end_time=", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "storyboard.vtt" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_start_time", "value": "" }, { "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_end_time", "value": "" }, { "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_start_time", "value": "" }, { "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_end_time", "value": "" } ], "variable": [ { "id": "d753a195-6618-4568-bfaa-e23a29d7db0f", "key": "PLAYBACK_ID", "value": "", "description": "(Required) The asset or live stream's playback ID." } ] }, "description": "Fetch metadata for the [storyboard image in WebVTT format](https://docs.mux.com/guides/create-timeline-hover-previews#webvtt), detailing the coordinates and time ranges of each thumbnail." }, "response": [ { "id": "2d334c01-384c-40fa-891a-528271543b2a", "name": "WebVTT metadata retrieved successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "text/vtt" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/storyboard.vtt?TOKEN=&program_start_time=&program_end_time=&asset_start_time=&asset_end_time=", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "storyboard.vtt" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_start_time", "value": "" }, { "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_end_time", "value": "" }, { "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_start_time", "value": "" }, { "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_end_time", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/vtt" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-2d334c01-384c-40fa-891a-528271543b2a" }, { "id": "72535768-0584-4118-a423-ed9877949f87", "name": "Bad request due to invalid parameters.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/storyboard.vtt?TOKEN=&program_start_time=&program_end_time=&asset_start_time=&asset_end_time=", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "storyboard.vtt" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_start_time", "value": "" }, { "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_end_time", "value": "" }, { "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_start_time", "value": "" }, { "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_end_time", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-72535768-0584-4118-a423-ed9877949f87" }, { "id": "b0f2adc1-028c-40e3-a764-7853fb86284d", "name": "Video asset not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/storyboard.vtt?TOKEN=&program_start_time=&program_end_time=&asset_start_time=&asset_end_time=", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "storyboard.vtt" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_start_time", "value": "" }, { "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_end_time", "value": "" }, { "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_start_time", "value": "" }, { "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_end_time", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b0f2adc1-028c-40e3-a764-7853fb86284d" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-9ab80444-b896-410c-82a0-37cedaa777d2" } ], "id": "29b44521-ac5f-42c4-b1a5-b5c59d10d6cb", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-29b44521-ac5f-42c4-b1a5-b5c59d10d6cb" }, { "name": "storyboard.json", "item": [ { "name": "Retrieve Storyboard Metadata in JSON Format", "id": "5c984634-60bb-455c-b7a1-b8f42e37f477", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/storyboard.json?TOKEN=&program_start_time=&program_end_time=&asset_start_time=&asset_end_time=&format=jpg", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "storyboard.json" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_start_time", "value": "" }, { "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_end_time", "value": "" }, { "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_start_time", "value": "" }, { "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_end_time", "value": "" }, { "description": "The format of the storyboard image URL in the response. Can be either 'jpg', 'png', or 'webp'. Defaults to 'jpg'.", "key": "format", "value": "jpg" } ], "variable": [ { "id": "da03fa6d-abba-43a2-8071-e06b7180d2df", "key": "PLAYBACK_ID", "value": "", "description": "(Required) The asset or live stream's playback ID." } ] }, "description": "Fetch metadata for the [storyboard image in JSON format](https://docs.mux.com/guides/create-timeline-hover-previews#json), detailing the coordinates and time ranges of each thumbnail." }, "response": [ { "id": "3cc0ee18-acf1-40cc-9251-4d8cfffd08a6", "name": "JSON storyboard retrieved successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/storyboard.json?TOKEN=&program_start_time=&program_end_time=&asset_start_time=&asset_end_time=&format=jpg", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "storyboard.json" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_start_time", "value": "" }, { "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_end_time", "value": "" }, { "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_start_time", "value": "" }, { "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_end_time", "value": "" }, { "description": "The format of the storyboard image URL in the response. Can be either 'jpg', 'png', or 'webp'. Defaults to 'jpg'.", "key": "format", "value": "jpg" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-3cc0ee18-acf1-40cc-9251-4d8cfffd08a6" }, { "id": "a623457b-174f-4677-8bb5-db5ca7355c4c", "name": "Bad request due to invalid parameters.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/storyboard.json?TOKEN=&program_start_time=&program_end_time=&asset_start_time=&asset_end_time=&format=jpg", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "storyboard.json" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_start_time", "value": "" }, { "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_end_time", "value": "" }, { "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_start_time", "value": "" }, { "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_end_time", "value": "" }, { "description": "The format of the storyboard image URL in the response. Can be either 'jpg', 'png', or 'webp'. Defaults to 'jpg'.", "key": "format", "value": "jpg" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a623457b-174f-4677-8bb5-db5ca7355c4c" }, { "id": "6c21c5d9-55df-43c7-8602-1668b5f6bbd4", "name": "Video asset not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://image.mux.com/:PLAYBACK_ID/storyboard.json?TOKEN=&program_start_time=&program_end_time=&asset_start_time=&asset_end_time=&format=jpg", "protocol": "https", "host": [ "image", "mux", "com" ], "path": [ ":PLAYBACK_ID", "storyboard.json" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_start_time", "value": "" }, { "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_end_time", "value": "" }, { "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_start_time", "value": "" }, { "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_end_time", "value": "" }, { "description": "The format of the storyboard image URL in the response. Can be either 'jpg', 'png', or 'webp'. Defaults to 'jpg'.", "key": "format", "value": "jpg" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-6c21c5d9-55df-43c7-8602-1668b5f6bbd4" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-5c984634-60bb-455c-b7a1-b8f42e37f477" } ], "id": "62597174-8f48-4212-8bb1-aead37ae2008", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-62597174-8f48-4212-8bb1-aead37ae2008" }, { "name": "{FILENAME}", "item": [ { "name": "Retrieve a Static Rendition", "id": "7de7c790-b7db-438d-be4e-8378e0fff552", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "video/mp4" } ], "url": { "raw": "https://stream.mux.com/:PLAYBACK_ID/:FILENAME?TOKEN=", "protocol": "https", "host": [ "stream", "mux", "com" ], "path": [ ":PLAYBACK_ID", ":FILENAME" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" } ], "variable": [ { "id": "6a017299-b6ab-453a-b9b3-b8f892672a83", "key": "PLAYBACK_ID", "value": "", "description": "(Required) The asset or live stream's playback ID." }, { "id": "4f611743-a860-470e-b35b-fc11396e5d2b", "key": "FILENAME", "value": "low.mp4", "description": "(Required) The filename of the static rendition file, as returned from the static renditions API files list. [See the MP4 guide for more details.](https://docs.mux.com/guides/enable-static-mp4-renditions)" } ] }, "description": "Fetch a static rendition (usually an MP4 or M4A file) of the specified video asset. [MP4 Support](https://docs.mux.com/guides/enable-static-mp4-renditions) must be enabled on the asset before using these URLs." }, "response": [ { "id": "e5474b32-62ba-47f2-970a-f34779e20d03", "name": "MP4 file retrieved successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "video/mp4" } ], "url": { "raw": "https://stream.mux.com/:PLAYBACK_ID/:FILENAME?TOKEN=", "protocol": "https", "host": [ "stream", "mux", "com" ], "path": [ ":PLAYBACK_ID", ":FILENAME" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" }, { "key": "FILENAME" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "video/mp4" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e5474b32-62ba-47f2-970a-f34779e20d03" }, { "id": "31881030-814f-4187-a782-7b6e450b979d", "name": "Invalid request due to missing or incorrect parameters.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://stream.mux.com/:PLAYBACK_ID/:FILENAME?TOKEN=", "protocol": "https", "host": [ "stream", "mux", "com" ], "path": [ ":PLAYBACK_ID", ":FILENAME" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" }, { "key": "FILENAME" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-31881030-814f-4187-a782-7b6e450b979d" }, { "id": "03f777bf-5694-4c66-aee3-dd200789930c", "name": "The requested video asset or rendition was not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://stream.mux.com/:PLAYBACK_ID/:FILENAME?TOKEN=", "protocol": "https", "host": [ "stream", "mux", "com" ], "path": [ ":PLAYBACK_ID", ":FILENAME" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" }, { "key": "FILENAME" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-03f777bf-5694-4c66-aee3-dd200789930c" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-7de7c790-b7db-438d-be4e-8378e0fff552" } ], "id": "ddaf6995-3447-458c-a1bd-6696a7006224", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-ddaf6995-3447-458c-a1bd-6696a7006224" }, { "name": "text", "item": [ { "name": "{TRACK_ID}.vtt", "item": [ { "name": "Retrieve a WebVTT File for a Text Track", "id": "2b6b8e95-56ef-40bb-be4e-957f437f39f2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "text/vtt" } ], "url": { "raw": "https://stream.mux.com/:PLAYBACK_ID/text/{{TRACK_ID}}.vtt?TOKEN=", "protocol": "https", "host": [ "stream", "mux", "com" ], "path": [ ":PLAYBACK_ID", "text", "{{TRACK_ID}}.vtt" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" } ], "variable": [ { "id": "478aa722-bb56-40d8-8a2b-40e5d4d257bd", "key": "PLAYBACK_ID", "value": "", "description": "(Required) The asset or live stream's playback ID." } ] }, "description": "Fetch a standalone WebVTT version of a text track from an asset." }, "response": [ { "id": "8485164f-e17c-428e-9bf9-fca68e2e9ac4", "name": "WebVTT retrieved successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "text/vtt" } ], "url": { "raw": "https://stream.mux.com/:PLAYBACK_ID/text/{{TRACK_ID}}.vtt?TOKEN=", "protocol": "https", "host": [ "stream", "mux", "com" ], "path": [ ":PLAYBACK_ID", "text", "{{TRACK_ID}}.vtt" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/vtt" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-8485164f-e17c-428e-9bf9-fca68e2e9ac4" }, { "id": "8dcfde96-89f6-49c8-b472-c525d6f4baa6", "name": "Invalid request due to missing or incorrect parameters.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://stream.mux.com/:PLAYBACK_ID/text/{{TRACK_ID}}.vtt?TOKEN=", "protocol": "https", "host": [ "stream", "mux", "com" ], "path": [ ":PLAYBACK_ID", "text", "{{TRACK_ID}}.vtt" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-8dcfde96-89f6-49c8-b472-c525d6f4baa6" }, { "id": "72585ed0-e208-462d-bd54-1801ee7172d9", "name": "The requested text track was not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://stream.mux.com/:PLAYBACK_ID/text/{{TRACK_ID}}.vtt?TOKEN=", "protocol": "https", "host": [ "stream", "mux", "com" ], "path": [ ":PLAYBACK_ID", "text", "{{TRACK_ID}}.vtt" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-72585ed0-e208-462d-bd54-1801ee7172d9" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-2b6b8e95-56ef-40bb-be4e-957f437f39f2" } ], "id": "3d877f67-c619-46a1-b340-503a3680f332", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-3d877f67-c619-46a1-b340-503a3680f332" }, { "name": "{TRACK_ID}.txt", "item": [ { "name": "Retrieve a Transcript", "id": "17b13eed-4e06-4f07-8f5e-2975111cefd0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "text/plain" } ], "url": { "raw": "https://stream.mux.com/:PLAYBACK_ID/text/{{TRACK_ID}}.txt?TOKEN=", "protocol": "https", "host": [ "stream", "mux", "com" ], "path": [ ":PLAYBACK_ID", "text", "{{TRACK_ID}}.txt" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" } ], "variable": [ { "id": "a22968fd-568d-437c-a86b-1f7244759bc2", "key": "PLAYBACK_ID", "value": "", "description": "(Required) The asset or live stream's playback ID." } ] }, "description": "Fetch a [transcript of an asset](https://docs.mux.com/guides/add-autogenerated-captions-and-use-transcripts#retrieve-a-transcript). This is only possible for assets with a text track generated using the [VOD generated captions feature](https://docs.mux.com/guides/add-autogenerated-captions-and-use-transcripts)." }, "response": [ { "id": "f75f30e5-3ccf-416e-92b1-4efa9c860e14", "name": "Transcript retrieved successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "text/plain" } ], "url": { "raw": "https://stream.mux.com/:PLAYBACK_ID/text/{{TRACK_ID}}.txt?TOKEN=", "protocol": "https", "host": [ "stream", "mux", "com" ], "path": [ ":PLAYBACK_ID", "text", "{{TRACK_ID}}.txt" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f75f30e5-3ccf-416e-92b1-4efa9c860e14" }, { "id": "e1ddb8fa-db1c-40b5-99e3-65582e085fc2", "name": "Invalid request due to missing or incorrect parameters.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://stream.mux.com/:PLAYBACK_ID/text/{{TRACK_ID}}.txt?TOKEN=", "protocol": "https", "host": [ "stream", "mux", "com" ], "path": [ ":PLAYBACK_ID", "text", "{{TRACK_ID}}.txt" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e1ddb8fa-db1c-40b5-99e3-65582e085fc2" }, { "id": "f46f418f-063c-46bf-aaa0-5ad1340779a0", "name": "The requested text track was not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://stream.mux.com/:PLAYBACK_ID/text/{{TRACK_ID}}.txt?TOKEN=", "protocol": "https", "host": [ "stream", "mux", "com" ], "path": [ ":PLAYBACK_ID", "text", "{{TRACK_ID}}.txt" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" } ], "variable": [ { "key": "PLAYBACK_ID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-f46f418f-063c-46bf-aaa0-5ad1340779a0" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-17b13eed-4e06-4f07-8f5e-2975111cefd0" } ], "id": "32014443-a8fe-408f-b872-7db42d4bac10", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-32014443-a8fe-408f-b872-7db42d4bac10" } ], "id": "8de2dc27-0e2a-4bec-a200-e2d4c13a4c77", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-8de2dc27-0e2a-4bec-a200-e2d4c13a4c77" } ], "id": "a1323563-e371-4918-b8e4-7bf546c373ab", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-a1323563-e371-4918-b8e4-7bf546c373ab" }, { "name": "{PLAYBACK_ID}.m3u8", "item": [ { "name": "Retrieve HLS Manifest", "id": "b040c7b7-e1db-445a-8147-e938347ab2b2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.apple.mpegurl" } ], "url": { "raw": "https://stream.mux.com/{{PLAYBACK_ID}}.m3u8?TOKEN=&redundant_streams=&roku_trick_play=&default_subtitles_lang=&max_resolution=270p&min_resolution=270p&rendition_order=desc&program_start_time=&program_end_time=&asset_start_time=&asset_end_time=&exclude_pdt=", "protocol": "https", "host": [ "stream", "mux", "com" ], "path": [ "{{PLAYBACK_ID}}.m3u8" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "Include [HLS redundant streams](https://docs.mux.com/guides/play-your-videos#add-delivery-redundancy-with-redundant-streams) in the manifest.", "key": "redundant_streams", "value": "" }, { "description": "Add support for [timeline hover previews on Roku devices](https://docs.mux.com/guides/create-timeline-hover-previews#roku-trick-play).", "key": "roku_trick_play", "value": "" }, { "description": "Set the [default subtitles/captions language](https://docs.mux.com/guides/add-subtitles-to-your-videos#showing-subtitles-by-default) (BCP47 compliant language code).", "key": "default_subtitles_lang", "value": "" }, { "description": "Set the [maximum resolution](https://docs.mux.com/guides/control-playback-resolution#specify-maximum-resolution) of renditions included in the manifest.", "key": "max_resolution", "value": "270p" }, { "description": "Set the [minimum resolution](https://docs.mux.com/guides/control-playback-resolution#specify-minimum-resolution) of renditions included in the manifest.", "key": "min_resolution", "value": "270p" }, { "description": "Set the logic to [order renditions in the HLS manifest](https://www.mux.com/blog/more-tools-to-control-playback-behavior-min-resolution-and-rendition-order#rendition_order).", "key": "rendition_order", "value": "desc" }, { "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_start_time", "value": "" }, { "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_end_time", "value": "" }, { "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_start_time", "value": "" }, { "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_end_time", "value": "" }, { "description": "If set to true, EXT-X-PROGRAM-DATE-TIME tags will be omitted from HLS manifests for assets from live streams.", "key": "exclude_pdt", "value": "" } ] }, "description": "Fetch an HLS (HTTP Live Streaming) playlist for the specified video asset, with optional query parameters to [modify playback behavior](https://docs.mux.com/guides/modify-playback-behavior)." }, "response": [ { "id": "559bd9ec-c0a2-4c85-9939-fcf75c411332", "name": "HLS playlist retrieved successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.apple.mpegurl" } ], "url": { "raw": "https://stream.mux.com/{{PLAYBACK_ID}}.m3u8?TOKEN=&redundant_streams=&roku_trick_play=&default_subtitles_lang=&max_resolution=270p&min_resolution=270p&rendition_order=desc&program_start_time=&program_end_time=&asset_start_time=&asset_end_time=&exclude_pdt=", "protocol": "https", "host": [ "stream", "mux", "com" ], "path": [ "{{PLAYBACK_ID}}.m3u8" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "Include [HLS redundant streams](https://docs.mux.com/guides/play-your-videos#add-delivery-redundancy-with-redundant-streams) in the manifest.", "key": "redundant_streams", "value": "" }, { "description": "Add support for [timeline hover previews on Roku devices](https://docs.mux.com/guides/create-timeline-hover-previews#roku-trick-play).", "key": "roku_trick_play", "value": "" }, { "description": "Set the [default subtitles/captions language](https://docs.mux.com/guides/add-subtitles-to-your-videos#showing-subtitles-by-default) (BCP47 compliant language code).", "key": "default_subtitles_lang", "value": "" }, { "description": "Set the [maximum resolution](https://docs.mux.com/guides/control-playback-resolution#specify-maximum-resolution) of renditions included in the manifest.", "key": "max_resolution", "value": "270p" }, { "description": "Set the [minimum resolution](https://docs.mux.com/guides/control-playback-resolution#specify-minimum-resolution) of renditions included in the manifest.", "key": "min_resolution", "value": "270p" }, { "description": "Set the logic to [order renditions in the HLS manifest](https://www.mux.com/blog/more-tools-to-control-playback-behavior-min-resolution-and-rendition-order#rendition_order).", "key": "rendition_order", "value": "desc" }, { "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_start_time", "value": "" }, { "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_end_time", "value": "" }, { "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_start_time", "value": "" }, { "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_end_time", "value": "" }, { "description": "If set to true, EXT-X-PROGRAM-DATE-TIME tags will be omitted from HLS manifests for assets from live streams.", "key": "exclude_pdt", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/vnd.apple.mpegurl" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-559bd9ec-c0a2-4c85-9939-fcf75c411332" }, { "id": "b0407c76-da1f-440f-a661-a6ab770a4fcc", "name": "Bad request due to invalid parameters.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://stream.mux.com/{{PLAYBACK_ID}}.m3u8?TOKEN=&redundant_streams=&roku_trick_play=&default_subtitles_lang=&max_resolution=270p&min_resolution=270p&rendition_order=desc&program_start_time=&program_end_time=&asset_start_time=&asset_end_time=&exclude_pdt=", "protocol": "https", "host": [ "stream", "mux", "com" ], "path": [ "{{PLAYBACK_ID}}.m3u8" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "Include [HLS redundant streams](https://docs.mux.com/guides/play-your-videos#add-delivery-redundancy-with-redundant-streams) in the manifest.", "key": "redundant_streams", "value": "" }, { "description": "Add support for [timeline hover previews on Roku devices](https://docs.mux.com/guides/create-timeline-hover-previews#roku-trick-play).", "key": "roku_trick_play", "value": "" }, { "description": "Set the [default subtitles/captions language](https://docs.mux.com/guides/add-subtitles-to-your-videos#showing-subtitles-by-default) (BCP47 compliant language code).", "key": "default_subtitles_lang", "value": "" }, { "description": "Set the [maximum resolution](https://docs.mux.com/guides/control-playback-resolution#specify-maximum-resolution) of renditions included in the manifest.", "key": "max_resolution", "value": "270p" }, { "description": "Set the [minimum resolution](https://docs.mux.com/guides/control-playback-resolution#specify-minimum-resolution) of renditions included in the manifest.", "key": "min_resolution", "value": "270p" }, { "description": "Set the logic to [order renditions in the HLS manifest](https://www.mux.com/blog/more-tools-to-control-playback-behavior-min-resolution-and-rendition-order#rendition_order).", "key": "rendition_order", "value": "desc" }, { "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_start_time", "value": "" }, { "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_end_time", "value": "" }, { "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_start_time", "value": "" }, { "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_end_time", "value": "" }, { "description": "If set to true, EXT-X-PROGRAM-DATE-TIME tags will be omitted from HLS manifests for assets from live streams.", "key": "exclude_pdt", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b0407c76-da1f-440f-a661-a6ab770a4fcc" }, { "id": "94f765e6-7a49-4810-9d16-5248a817e0a2", "name": "Video asset not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://stream.mux.com/{{PLAYBACK_ID}}.m3u8?TOKEN=&redundant_streams=&roku_trick_play=&default_subtitles_lang=&max_resolution=270p&min_resolution=270p&rendition_order=desc&program_start_time=&program_end_time=&asset_start_time=&asset_end_time=&exclude_pdt=", "protocol": "https", "host": [ "stream", "mux", "com" ], "path": [ "{{PLAYBACK_ID}}.m3u8" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" }, { "description": "Include [HLS redundant streams](https://docs.mux.com/guides/play-your-videos#add-delivery-redundancy-with-redundant-streams) in the manifest.", "key": "redundant_streams", "value": "" }, { "description": "Add support for [timeline hover previews on Roku devices](https://docs.mux.com/guides/create-timeline-hover-previews#roku-trick-play).", "key": "roku_trick_play", "value": "" }, { "description": "Set the [default subtitles/captions language](https://docs.mux.com/guides/add-subtitles-to-your-videos#showing-subtitles-by-default) (BCP47 compliant language code).", "key": "default_subtitles_lang", "value": "" }, { "description": "Set the [maximum resolution](https://docs.mux.com/guides/control-playback-resolution#specify-maximum-resolution) of renditions included in the manifest.", "key": "max_resolution", "value": "270p" }, { "description": "Set the [minimum resolution](https://docs.mux.com/guides/control-playback-resolution#specify-minimum-resolution) of renditions included in the manifest.", "key": "min_resolution", "value": "270p" }, { "description": "Set the logic to [order renditions in the HLS manifest](https://www.mux.com/blog/more-tools-to-control-playback-behavior-min-resolution-and-rendition-order#rendition_order).", "key": "rendition_order", "value": "desc" }, { "description": "Set the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_start_time", "value": "" }, { "description": "Set the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.", "key": "program_end_time", "value": "" }, { "description": "Set the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_start_time", "value": "" }, { "description": "Set the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).", "key": "asset_end_time", "value": "" }, { "description": "If set to true, EXT-X-PROGRAM-DATE-TIME tags will be omitted from HLS manifests for assets from live streams.", "key": "exclude_pdt", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messages\": [\n \"\",\n \"\"\n ],\n \"type\": \"\",\n \"code\": \"\"\n },\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-94f765e6-7a49-4810-9d16-5248a817e0a2" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b040c7b7-e1db-445a-8147-e938347ab2b2" } ], "id": "e32a63a0-7e62-452b-aa4b-e06de2d0d712", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-e32a63a0-7e62-452b-aa4b-e06de2d0d712" }, { "name": "counts", "item": [ { "name": "Retrieve the View and Viewer Counts", "id": "b7e27019-079c-4e58-8de7-376005720ad6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://stats.mux.com/counts?TOKEN=", "protocol": "https", "host": [ "stats", "mux", "com" ], "path": [ "counts" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" } ] }, "description": "[Fetch the real-time view and viewer counts for a video](https://docs.mux.com/guides/see-how-many-people-are-watching)." }, "response": [ { "id": "ec129031-3238-4b07-a3eb-abbc56854339", "name": "Counts retrieved successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://stats.mux.com/counts?TOKEN=", "protocol": "https", "host": [ "stats", "mux", "com" ], "path": [ "counts" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"views\": {\n \"schema\": 24002780\n },\n \"viewers\": {\n \"schema\": 33714722\n },\n \"updated_at\": {\n \"schema\": \"1972-07-07\"\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-ec129031-3238-4b07-a3eb-abbc56854339" }, { "id": "5cf4d125-e1b1-4eac-b818-0cb7fc8f1e86", "name": "Bad request due to missing or invalid JWT token.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://stats.mux.com/counts?TOKEN=", "protocol": "https", "host": [ "stats", "mux", "com" ], "path": [ "counts" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": {\n \"schema\": \"aliquip labore amet irure\"\n },\n \"messages\": {\n \"schema\": [\n \"magna velit\",\n \"ut laboris\"\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-5cf4d125-e1b1-4eac-b818-0cb7fc8f1e86" }, { "id": "cfaf82e9-711a-4eb1-82d6-6f6093a7c248", "name": "Server timeout or unknown error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://stats.mux.com/counts?TOKEN=", "protocol": "https", "host": [ "stats", "mux", "com" ], "path": [ "counts" ], "query": [ { "description": "Signed token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).", "key": "TOKEN", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": {\n \"schema\": \"aliquip labore amet irure\"\n },\n \"messages\": {\n \"schema\": [\n \"magna velit\",\n \"ut laboris\"\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-cfaf82e9-711a-4eb1-82d6-6f6093a7c248" } ], "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b7e27019-079c-4e58-8de7-376005720ad6" } ], "id": "b24ae5a9-e1e4-47b9-b355-a4020053db17", "createdAt": "2026-06-05T15:01:33.000Z", "updatedAt": "2026-06-05T15:01:33.000Z", "uid": "35240-b24ae5a9-e1e4-47b9-b355-a4020053db17" } ], "variable": [ { "key": "baseUrl", "value": "https://api.mux.com" }, { "key": "EXTENSION", "value": "jpg" }, { "key": "TRACK_ID", "value": "" }, { "key": "PLAYBACK_ID", "value": "" } ] }