Operations related to live streams. A live stream is a single, linear video broadcast. You broadcast a live stream by receiving encoded source video into the Wowza Video service and letting Wowza Video transcode the stream and deliver it to viewers. A live stream is essentially a one-stop method for creating a transcoder, output renditions, stream targets, and associated players.
Wowza Video
/- Reference
- REST API
- Fetch an output
Transcoders
Output Renditions
Output Stream Targets
Create a transcoder
Fetch all transcoders
Fetch a transcoder
Update a transcoder
Delete a transcoder
Enable a transcoder's stream targets
Disable a transcoder's stream targets
Start a transcoder
Stop a transcoder
Reset a transcoder
Start recording
Stop recording
Fetch a transcoder's recordings
Fetch transcoder's schedules
Fetch the thumbnail URL of a transcoder
Fetch the state and uptime ID of a transcoder
Fetch all VOD streams for a transcoder
Fetch all uptime records for a transcoder
Fetch an uptime record
Create an output
Fetch all outputs of a transcoder
Update an output
Delete an output
Create an output stream target
Fetch all output stream targets of an output of a transcoder
Fetch an output stream target
Update an output stream target
Delete an output stream target
Enable an output stream target
Disable an output stream target
Restart an output stream target
Configure a property for a transcoder
Fetch a transcoder's properties
Fetch a property for a transcoder
Delete a transcoder's property
(Sunset) Fetch statistics for a current transcoder
(Sunset) Fetch current stream health metrics for an active transcoder
(Sunset) Fetch historic stream health metrics for a transcoder
Fetch an output
Wowza Video REST API Reference Documentation (v1.11)
API lifecycle phase: Supported 2
| Want to take the API for a test run? All you'll need is a Wowza Video subscription, or free trial, for the API access token. Then, fork our collection in Postman and you'll be making calls to our REST API in minutes! See Trial the Wowza Video REST API using Postman for more information. |
This reference documentation provides details about the operations, parameters, and request and reponse schemas for every resource and endpoint in the Wowza Video REST API. Samples appear in the right column. Sample requests are presented in cURL (Shell) and JavaScript; some samples also include just the JSON object. Response samples are all JSON. Examples in cURL use environment variables so you can easily copy and paste them. To learn more, see Using cURL.
Reference documentation is available for every version of the API. Use the Version menu at the top of the page to access the reference doc for a different version of the API.
Download OpenAPI description
Overview
License
Languages
Servers
Mock server
https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi
https://api.video.wowza.com/api/v1.11
- Mock serverhttps://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/transcoders/{transcoder_id}/outputs
- https://api.video.wowza.com/api/v1.11/transcoders/{transcoder_id}/outputs
- curl
- Java
- Python
- JavaScript
curl -i -X GET \
'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/transcoders/{transcoder_id}/outputs'Success
Example: [{"aspect_ratio_height":480,"aspect_ratio_width":848,"bitrate_audio":128,"bitrate_video":1600,"created_at":"2020-01-29T17:16:21.958Z","framerate_reduction":"1/2","h264_profile":"main","id":"w9vJm3BJ","keyframes":"follow_source","name":"Standard Output: Video (848 x 480) + Audio","output_stream_targets":[{}],"video_codec":"h264","audio_codec":"aac","transcoder_id":"PblTJm1t","updated_at":"2020-01-31T03:29:50.958Z"},{"created_at":"2020-01-29T17:16:21.958Z","id":"PPqV0kcm","name":"Standard Output: Video + Audio","output_stream_targets":[{}],"video_codec":"passthrough","audio_codec":"passthrough","transcoder_id":"Yf5lyjCV","updated_at":"2020-01-31T03:55:05.958Z"}]
The height, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1080. Combined with aspect_ratio_width, makes up the input resolution.
Example: 480
The width, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1920. Combined with aspect_ratio_height, makes up the input resolution.
Example: 848
The audio bitrate, in kilobits per second (Kbps). Must be between 1 and 9999. If the audio_codec is opus, the default is 510, otherwise the default is 128.
Example: 128
The video bitrate, in kilobits per second (Kbps). Must be between 1 and 10240. The default is 4000.
Example: 1600
The date and time that the output rendition was created.
Example: "2020-01-29T17:16:21.964Z"
Reduce the frame rate of the transcoded output rendition. The default, 0, uses the encoded stream's frame rate without reduction.
Enum"0""1/2""1/4""1/25""1/30""1/50""1/60"
Example: "1/2"
The encoding method. Specify main for desktop streaming, baseline for playback on mobile devices, or high for HD playback. The default is high.
Enum"main""baseline""high"
Example: "main"
The unique alphanumeric string that identifies the output rendition.
Example: "w9vJm3BJ"
The interval used to define the compression applied to a group of frames. The default, follow_source, uses the keyframe interval of the source video.
Enum"follow_source""25""30""50""60""100""120"
Example: "follow_source"
A descriptive name for the output (generated, not writable).
Example: "Standard Output: Video (848 x 480) + Audio"
The codec used to encode the video stream. disabled sends the stream without a video track and passthrough sends the stream without transcoding the video track. Available from version 1.6.
Enum"h264""passthrough""disabled"
Example: "h264"
The codec used to encode the audio stream. disabled sends the stream without an audio track and passthrough sends the stream without transcoding the audio track. aac is the most commonly compatible audio codec for protocols, while opus is for WebRTC streams. Available from version 1.6.
Enum"aac""opus""passthrough""disabled"
Example: "aac"
The unique alphanumeric string that identifies the transcoder.
Example: "PblTJm1t"
Response
application/json
{ "outputs": [ { … }, { … } ] }
- Mock serverhttps://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/transcoders/{transcoder_id}/outputs/{id}
- https://api.video.wowza.com/api/v1.11/transcoders/{transcoder_id}/outputs/{id}
- curl
- Java
- Python
- JavaScript
curl -i -X GET \
'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/transcoders/{transcoder_id}/outputs/{id}'Success
Example: {"aspect_ratio_height":480,"aspect_ratio_width":848,"bitrate_audio":128,"bitrate_video":1600,"created_at":"2020-01-29T17:16:21.964Z","framerate_reduction":"1/2","h264_profile":"main","id":"w9vJm3BJ","keyframes":"follow_source","name":"Standard Output: Video (848 x 480) + Audio","output_stream_targets":[{}],"video_codec":"h264","audio_codec":"aac","transcoder_id":"PblTJm1t","updated_at":"2020-01-31T13:47:33.964Z"}
The height, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1080. Combined with aspect_ratio_width, makes up the input resolution.
Example: 480
The width, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1920. Combined with aspect_ratio_height, makes up the input resolution.
Example: 848
The audio bitrate, in kilobits per second (Kbps). Must be between 1 and 9999. If the audio_codec is opus, the default is 510, otherwise the default is 128.
Example: 128
The video bitrate, in kilobits per second (Kbps). Must be between 1 and 10240. The default is 4000.
Example: 1600
The date and time that the output rendition was created.
Example: "2020-01-29T17:16:21.964Z"
Reduce the frame rate of the transcoded output rendition. The default, 0, uses the encoded stream's frame rate without reduction.
Enum"0""1/2""1/4""1/25""1/30""1/50""1/60"
Example: "1/2"
The encoding method. Specify main for desktop streaming, baseline for playback on mobile devices, or high for HD playback. The default is high.
Enum"main""baseline""high"
Example: "main"
The unique alphanumeric string that identifies the output rendition.
Example: "w9vJm3BJ"
The interval used to define the compression applied to a group of frames. The default, follow_source, uses the keyframe interval of the source video.
Enum"follow_source""25""30""50""60""100""120"
Example: "follow_source"
A descriptive name for the output (generated, not writable).
Example: "Standard Output: Video (848 x 480) + Audio"
The codec used to encode the video stream. disabled sends the stream without a video track and passthrough sends the stream without transcoding the video track. Available from version 1.6.
Enum"h264""passthrough""disabled"
Example: "h264"
The codec used to encode the audio stream. disabled sends the stream without an audio track and passthrough sends the stream without transcoding the audio track. aac is the most commonly compatible audio codec for protocols, while opus is for WebRTC streams. Available from version 1.6.
Enum"aac""opus""passthrough""disabled"
Example: "aac"
The unique alphanumeric string that identifies the transcoder.
Example: "PblTJm1t"
Response
application/json
{ "output": { "aspect_ratio_height": 480, "aspect_ratio_width": 848, "bitrate_audio": 128, "bitrate_video": 1600, "created_at": "2020-01-29T17:16:21.964Z", "framerate_reduction": "1/2", "h264_profile": "main", "id": "w9vJm3BJ", "keyframes": "follow_source", "name": "Standard Output: Video (848 x 480) + Audio", "output_stream_targets": [ … ], "video_codec": "h264", "audio_codec": "aac", "transcoder_id": "PblTJm1t", "updated_at": "2020-01-31T13:47:33.964Z" } }
Bodyapplication/jsonrequired
Provide the details of the output rendition to update in the body of the request.
Example: {"video_codec":"h264","audio_codec":"aac","aspect_ratio_height":480,"aspect_ratio_width":848,"bitrate_audio":128,"bitrate_video":1600,"framerate_reduction":"1/2","h264_profile":"main","keyframes":"follow_source"}
The codec used to encode the video stream. disabled sends the stream without a video track and passthrough sends the stream without transcoding the video track. Available from version 1.6.
Enum"h264""passthrough""disabled"
Example: "h264"
The codec used to encode the audio stream. disabled sends the stream without an audio track and passthrough sends the stream without transcoding the audio track. aac is the most commonly compatible audio codec for protocols, while opus is for WebRTC streams. Available from version 1.6.
Enum"aac""opus""passthrough""disabled"
Example: "aac"
The height, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1080. Combined with aspect_ratio_width, makes up the input resolution.
Example: "aspect_ratio_height": 1080
Example: 480
The width, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1920. Combined with aspect_ratio_height, makes up the input resolution.
Example: "aspect_ratio_width": 1920
Example: 848
The audio bitrate, in kilobits per second (Kbps). Must be between 1 and 9999. If the audio_codec is opus, the default is 510, otherwise the default is 128.
Example: "bitrate_audio": 128
Example: 128
The video bitrate, in kilobits per second (Kbps). Must be between 1 and 10240. The default is 4000.
Example: "bitrate_audio": 1600
Example: 1600
Reduce the frame rate of the transcoded output rendition. The default, 0, uses the encoded stream's frame rate without reduction.
Example: "frame_reduction": "1/2"
Enum"0""1/2""1/4""1/25""1/30""1/50""1/60"
Example: "1/2"
The encoding method. Specify main for desktop streaming, baseline for playback on mobile devices, or high for HD playback. The default is high.
Example: "h264_profile": "main"
Enum"main""baseline""high"
Example: "main"
- Mock serverhttps://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/transcoders/{transcoder_id}/outputs/{id}
- https://api.video.wowza.com/api/v1.11/transcoders/{transcoder_id}/outputs/{id}
- curl
- Java
- Python
- JavaScript
curl -i -X PATCH \
'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/transcoders/{transcoder_id}/outputs/{id}' \
-H 'Content-Type: application/json' \
-d '{
"output": {
"video_codec": "h264",
"audio_codec": "aac",
"aspect_ratio_height": 480,
"aspect_ratio_width": 848,
"bitrate_audio": 128,
"bitrate_video": 1600,
"framerate_reduction": "1/2",
"h264_profile": "main",
"keyframes": "follow_source"
}
}'Success
Example: {"aspect_ratio_height":480,"aspect_ratio_width":848,"bitrate_audio":128,"bitrate_video":1600,"created_at":"2020-01-29T17:16:21.964Z","framerate_reduction":"1/2","h264_profile":"main","id":"w9vJm3BJ","keyframes":"follow_source","name":"Standard Output: Video (848 x 480) + Audio","output_stream_targets":[{}],"video_codec":"h264","audio_codec":"aac","transcoder_id":"PblTJm1t","updated_at":"2020-01-31T13:47:33.964Z"}
The height, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1080. Combined with aspect_ratio_width, makes up the input resolution.
Example: 480
The width, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1920. Combined with aspect_ratio_height, makes up the input resolution.
Example: 848
The audio bitrate, in kilobits per second (Kbps). Must be between 1 and 9999. If the audio_codec is opus, the default is 510, otherwise the default is 128.
Example: 128
The video bitrate, in kilobits per second (Kbps). Must be between 1 and 10240. The default is 4000.
Example: 1600
The date and time that the output rendition was created.
Example: "2020-01-29T17:16:21.964Z"
Reduce the frame rate of the transcoded output rendition. The default, 0, uses the encoded stream's frame rate without reduction.
Enum"0""1/2""1/4""1/25""1/30""1/50""1/60"
Example: "1/2"
The encoding method. Specify main for desktop streaming, baseline for playback on mobile devices, or high for HD playback. The default is high.
Enum"main""baseline""high"
Example: "main"
The unique alphanumeric string that identifies the output rendition.
Example: "w9vJm3BJ"
The interval used to define the compression applied to a group of frames. The default, follow_source, uses the keyframe interval of the source video.
Enum"follow_source""25""30""50""60""100""120"
Example: "follow_source"
A descriptive name for the output (generated, not writable).
Example: "Standard Output: Video (848 x 480) + Audio"
The codec used to encode the video stream. disabled sends the stream without a video track and passthrough sends the stream without transcoding the video track. Available from version 1.6.
Enum"h264""passthrough""disabled"
Example: "h264"
The codec used to encode the audio stream. disabled sends the stream without an audio track and passthrough sends the stream without transcoding the audio track. aac is the most commonly compatible audio codec for protocols, while opus is for WebRTC streams. Available from version 1.6.
Enum"aac""opus""passthrough""disabled"
Example: "aac"
The unique alphanumeric string that identifies the transcoder.
Example: "PblTJm1t"
Response
application/json
{ "output": { "aspect_ratio_height": 480, "aspect_ratio_width": 848, "bitrate_audio": 128, "bitrate_video": 1600, "created_at": "2020-01-29T17:16:21.964Z", "framerate_reduction": "1/2", "h264_profile": "main", "id": "w9vJm3BJ", "keyframes": "follow_source", "name": "Standard Output: Video (848 x 480) + Audio", "output_stream_targets": [ … ], "video_codec": "h264", "audio_codec": "aac", "transcoder_id": "PblTJm1t", "updated_at": "2020-01-31T13:47:33.964Z" } }
Operations related to recordings, which are created through the /live_streams or /transcoders resources. The Wowza Video service can create MP4 recordings of your live streams and transcoded output. Recordings can be downloaded and saved locally. They're based on the highest-bitrate output rendition that Wowza Video generates from your video source. See About recordings to learn more.
Operations
Operations related to schedules. Schedules allow you to automatically start or stop a live stream or transcoder at a predetermined date and time. You can configure a schedule to start and/or stop a live stream or transcoder just once, or you can configure it to repeat the behavior on a regular basis. See About schedules to learn more.
Operations
Operations related to video on demand (VOD) streams, which are created through the /live_streams or /transcoders resources. A VOD stream is a recording of a live stream that viewers can replay at a later date. After the broadcast is over and the live stream or transcoder is stopped, Wowza Video creates the VOD stream and generates a playback URL. See About VOD Streams to learn more.
Operations
Operations related to Real-Time Streaming at Scale. If your audience is fewer than 300 viewers or you want to deliver a stream in near real time alongside other delivery protocols, use our WebRTC solution.
To enable and purchase capacity for Real-Time Streaming at Scale for your account and access the /real_time operations, contact 720.279.8163 or schedule a call.
Operations