Assets

Operations related to assets, which are created through the /assets resources. The Wowza Video service can store and transcode mp4 files that you can tag, manage, and restream.

Create an asset

This operation creates an asset.

Request

Request Body schema: application/json

Provide the details of the asset to create in the body of the request.

object (asset)

file_name

required

string

The name of the mp4 file you are uploading.

Responses

201

Success

Response Schema: application/json

required

object (asset_create_output)

created_at	string <date-time> The date and time that the asset was created.
id	string The unique identifier of the asset. Use this ID to perform other operations on the stream, like getting the details of the asset or deleting it.
file_name	string The name of the mp4 file you are uploading.
upload_url	string The upload location for the asset. Use this URL to upload the .mp4 assets to the Wowza Video Asset Manager.

401

Unauthorized

422

Unprocessable Entity

post/assets

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"asset": {"file_name": "MyAsset.mp4"
}
}

Response samples

application/json

{"asset": {"created_at": "2021-06-30T18:02:20.000Z",
"id": "2adffc17",
"file_name": "MyAsset.mp4",
"upload_url": "https://storage.googleapis.com/qa-wse-recordings/uploads/recording_h4qntp5j/MyFile.mp4?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=wcl-transcoder%40useful-figure-89722.iam.gserviceaccount.com%2F20220214%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20220214T213737Z&X-Goog-Expires=300&X-Goog-SignedHeaders=content-type%3Bhost&X-Goog-Signature=994fe495425f26ba24e05233c066fdbcd0ab4c5779e1743f118141f61d353edb0eeafb463f766ca69deefb5910a7b29a8436c515f83871b0a4c5786236560bd28407ea9489458c4dc8d685d1601ac96cb71859ff8b5cff0e80a8ce43c5cf838e11b716ec9688138d96a879319b66cf73279cdba2d9a940bde73aa22d2fbb83bedaf8f477c44d65ebe4500fcdc07d4f19b3e40418fc689f48f84f5e96cf04e8f549108cb5ba7f134f8943101f0afe23dd7d38b982510696042f9dabb16cda21c02ed67deae5b752a787cb9dae1012ef772f4c2b3a959afb1fb1cf99f38fd557bedeb41b3399f2ba028b05c009424acf6055420d80f65b30235fec9e57e0bde7ef"
}
}

Fetch all assets

This operation shows limited details for all of your assets. For detailed information, fetch a single asset.

Request

query Parameters

filter	string Restricts the data that gets returned by filtering on one or more values associated with a field. Construct a filter using a two-part expression that specifies the field on which to filter and the logic to use to filter. Valid filter fields are created_at, id, name, and state. Valid filter operators are eq (equals), which accepts one value, and in (equals any of), which accepts a comma-separated string of values. Filters use a zero-based index. For example: filter[0][field]=state&filter[0][eq]=stopped For more information and examples, see the technical article How to get filtered query results with the Wowza Video REST API.
page	integer Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is 1. For more information and examples, see Get paginated query results with the Wowza Video REST API.
per_page	integer For use with the page parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is 1000.

Responses

200

Success

Response Schema: application/json

required

Array of objects (assets)

Array

created_at	string <date-time> The date and time that the asset was created.
download_url	string The URL that can be used to download the asset as a .MP4 file.
file_name	string The name of the mp4 file you uploaded.
file_size	integer <int64> The file size of the asset.
id	string The unique alphanumeric string that identifies the asset
name	string A descriptive name for the asset. Maximum 200 characters.
playback_enabled	boolean Specifies whether playback is enabled for an asset.
playback_url	string The address that can be used to configure playback of the stream.
processing_percentage	integer A percentage that describes how soon transcoding will complete.
state	string The state of the asset. Enum: "uploading" "processing" "completed" "failed"
thumbnail_url	string The URL to receive the preview thumbnail.
updated_at	string <date-time> The date and time that the asset was updated.

401

Unauthorized

get/assets

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/beta/assets"

Response samples

application/json

{"assets": [{"created_at": "2020-01-29T17:16:21.849Z",
"download_url": "https://storage.googleapis.com/qa-wse-recordings/zjpfl9f7/recording_xcwvfkgy/MyAsset.mp4",
"id": "wdjfqvsv",
"name": "MyAsset",
"playback_enabled": true,
"processing_percentage": 0.1,
"file_name": "MyFile.mp4",
"file_size": 1570024,
"playback_url": "https://wowzasubdomain/1/RmlPcnpsM0Z1Nzd2/SFhkUXlv/hls/live/playlist.m3u8",
"state": "completed",
"thumbnail_url": "https://storage.googleapis.com/qa-wse-recordings/zjpfl9f7/recording_zwpjcrpf/thumbnail.jpg",
"updated_at": "2020-01-31T16:06:47.849Z"
},
{"created_at": "2020-01-29T17:16:21.849Z",
"download_url": "https://storage.googleapis.com/qa-wse-recordings/zjpfl9f7/recording_xcwvfkgy/MyAsset2.mp4",
"id": "KyxWKtHQ",
"name": "MyAsset2",
"playback_enabled": true,
"processing_percentage": 0.3,
"file_name": "MyFile2.mp4",
"file_size": 70284,
"playback_url": "https://wowzasubdomain/1/U0VmOU90TmtvSzJP/Y2ltUkl2/hls/live/playlist.m3u8",
"state": "completed",
"thumbnail_url": "https://storage.googleapis.com/qa-wse-recordings/zjpfl9f7/recording_zwpjcrpf/thumbnail.jpg",
"updated_at": "2020-01-31T02:26:05.849Z"
},
{"created_at": "2020-01-29T17:16:21.849Z",
"download_url": "https://storage.googleapis.com/qa-wse-recordings/zjpfl9f7/recording_xcwvfkgy/MyAsset3.mp4",
"id": "Ly40ZDSg",
"name": "MyAsset3",
"playback_enabled": true,
"processing_percentage": 0,
"file_name": "MyFile3.mp4",
"file_size": 882391,
"playback_url": "https://wowzasubdomain/1/PmlPcnpsM0Z1Nzd2/SFhkUXlv/hls/live/playlist.m3u8",
"state": "completed",
"thumbnail_url": "https://storage.googleapis.com/qa-wse-recordings/zjpfl9f7/recording_zwpjcrpf/thumbnail.jpg",
"updated_at": "2020-01-30T18:13:18.849Z"
}
]
}

Fetch an asset

This operation shows the details of a specific asset.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the asset.

Responses

200

Success

Response Schema: application/json

required

object (asset)

	Array of objects (renditions) The renditions available for the asset.
average_view_time	integer <time> The average time that the asset has been viewed.
created_at	string <date-time> The date and time that the asset was created.
description	string A description of the asset. Maximum 16,000 characters.
download_url	string The URL that can be used to download the asset as a .MP4 file.
duration	string <time> The length of an asset, in hours, minutes, and seconds.
file_name	string The name of the mp4 file you uploaded.
file_size	integer The file size of the asset.
id	string The unique alphanumeric string that identifies the asset
name	string A descriptive name for the live stream. Maximum 200 characters.
playback_enabled	boolean Specifies whether playback is enabled for an asset.
playback_url	string The HLS URL for the stream associated with the asset.
processing_percentage	integer A percentage that describes how soon transcoding will complete.
recording_id	string An ID for the recording. You can use this to fetch additional information about the recording associated with the asset.
state	string The state of the asset. Enum: "uploading" "processing" "completed" "failed"
tags	array A list of tags associated with the asset.
thumbnail_url	string The URL to receive the preview thumbnail.
total_storage_size	integer The total storage size for the asset.
total_viewing_time	integer The total time that the asset has been viewed by anyone.
updated_at	string <date-time> The date and time that the asset was updated.
unique_viewers	integer The number of unique viewers for the stream.
vod_stream_id	string An ID for the VOD. You can use this to fetch additional information about the VOD stream associated with the asset, such as the size of only the VOD stream.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/assets/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/beta/assets/2adffc17"

Response samples

application/json

{"asset": {"available_renditions": [{"height": 480,
"width": 848,
"bitrate_kbps": 1600
}
],
"average_view_time": 44925498,
"created_at": "2021-06-30T18:02:20.000Z",
"description": "My Asset Description",
"download_url": "https://storage.googleapis.com/qa-wse-recordings/zjpfl9f7/recording_xcwvfkgy/MyAsset.mp4",
"duration": 30526,
"file_name": "MyAsset.mp4",
"file_size": 2372820,
"id": "i4qsbwvi",
"name": "My Asset",
"playback_enabled": true,
"playback_url": "https://cdn3-qa.wowza.com/2/T1R6V2hBV2hEdmJ0/ZnJUOE9q/hls/g7z7bwbz/playlist.m3u8",
"processing_percentage": 100,
"recording_id": "l8qsbwvu",
"state": "completed",
"tags": ["Tag1",
"Tag2",
"Tag3"
],
"thumbnail_url": "https://storage.googleapis.com/qa-wse-recordings/zjpfl9f7/recording_zwpjcrpf/thumbnail.jpg",
"total_storage_size": 19513598,
"total_viewing_time": 44925498,
"updated_at": "2021-06-30T18:02:20.000Z",
"unique_viewers": 5986,
"vod_stream_id": "l9qsbwvf"
}
}

Update an asset

This operation updates an asset. Assets must be uploaded and complete processing before they can be updated.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the asset.

Request Body schema: application/json

Provide the details of the asset to update in the body of the request.

required

object (asset)

description	string A description of the asset. Maximum 16,000 characters. Example: `"description": "My updated asset description"`
name	string A descriptive name for the live stream. Maximum 200 characters. Example: `"name": "My Updated Live Stream Asset"`
playback_enabled	boolean Specifies whether playback is enabled for an asset. Example: `"playback_enabled": true`
tags	array A list of tags associated with the asset. Example: `"tags": ["Tag1", "Tag2", "Tag3"]`

Responses

200

Success

Response Schema: application/json

required

object (asset)

	Array of objects (renditions) The renditions available for the asset.
average_view_time	integer <time> The average time that the asset has been viewed.
created_at	string <date-time> The date and time that the asset was created.
description	string A description of the asset. Maximum 16,000 characters.
download_url	string The URL that can be used to download the asset as a .MP4 file.
duration	string <time> The length of an asset, in hours, minutes, and seconds.
file_name	string The name of the mp4 file you uploaded.
file_size	integer The file size of the asset.
id	string The unique alphanumeric string that identifies the asset
name	string A descriptive name for the live stream. Maximum 200 characters.
playback_enabled	boolean Specifies whether playback is enabled for an asset.
playback_url	string The HLS URL for the stream associated with the asset.
processing_percentage	integer A percentage that describes how soon transcoding will complete.
recording_id	string An ID for the recording. You can use this to fetch additional information about the recording associated with the asset.
state	string The state of the asset. Enum: "uploading" "processing" "completed" "failed"
tags	array A list of tags associated with the asset.
thumbnail_url	string The URL to receive the preview thumbnail.
total_storage_size	integer The total storage size for the asset.
total_viewing_time	integer The total time that the asset has been viewed by anyone.
updated_at	string <date-time> The date and time that the asset was updated.
unique_viewers	integer The number of unique viewers for the stream.
vod_stream_id	string An ID for the VOD. You can use this to fetch additional information about the VOD stream associated with the asset, such as the size of only the VOD stream.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Asset Not Available

patch/assets/{id}

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"asset": {"description": "My Asset Description",
"name": "My Live Stream",
"playback_enabled": true,
"tags": ["Tag1",
"Tag2",
"Tag3"
]
}
}

Response samples

application/json

{"asset": {"available_renditions": [{"height": 480,
"width": 848,
"bitrate_kbps": 1600
}
],
"average_view_time": 44925498,
"created_at": "2021-06-30T18:02:20.000Z",
"description": "My Asset Description",
"download_url": "https://storage.googleapis.com/qa-wse-recordings/zjpfl9f7/recording_xcwvfkgy/MyAsset.mp4",
"duration": 30526,
"file_name": "MyAsset.mp4",
"file_size": 2372820,
"id": "i4qsbwvi",
"name": "My Asset",
"playback_enabled": true,
"playback_url": "https://cdn3-qa.wowza.com/2/T1R6V2hBV2hEdmJ0/ZnJUOE9q/hls/g7z7bwbz/playlist.m3u8",
"processing_percentage": 100,
"recording_id": "l8qsbwvu",
"state": "completed",
"tags": ["Tag1",
"Tag2",
"Tag3"
],
"thumbnail_url": "https://storage.googleapis.com/qa-wse-recordings/zjpfl9f7/recording_zwpjcrpf/thumbnail.jpg",
"total_storage_size": 19513598,
"total_viewing_time": 44925498,
"updated_at": "2021-06-30T18:02:20.000Z",
"unique_viewers": 5986,
"vod_stream_id": "l9qsbwvf"
}
}

Delete an asset

This operation deletes an asset, including all assigned outputs and targets. Assets must have completed uploading and processing before they can be deleted.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the asset.

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Asset Not Available

delete/assets/{id}

Request samples

Shell
JavaScript
Java
Python

curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WV_HOST}/api/beta/assets/2adffc17"

Response samples

application/json

{"Example Response 1": {"meta": {"status": 401,
"code": "ERR-401-NoApiKey",
"title": "No API Key Error",
"message": "No API key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 2": {"meta": {"status": 401,
"code": "ERR-401-NoAccessKey",
"title": "No Access Key Error",
"message": "No access key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 3": {"meta": {"status": 401,
"code": "ERR-401-InvalidApiKey",
"title": "Invalid Api Key Error",
"message": "Invalid API key.",
"description": "",
"links": [ ]
}
},
"Example Response 4": {"meta": {"status": 401,
"code": "ERR-401-InvalidAccessKey",
"title": "Invalid Access Key Error",
"message": "Invalid access key.",
"description": "",
"links": [ ]
}
},
"Example Response 5": {"meta": {"status": 401,
"code": "ERR-401-BadAccountStatus",
"title": "Bad Account Status Error",
"message": "Your account's status doesn't allow this action.",
"description": "",
"links": [ ]
}
},
"Example Response 6": {"meta": {"status": 401,
"code": "ERR-401-FeatureNotEnabled",
"title": "Feature Not Enabled Error",
"message": "This feature isn't enabled.",
"description": "",
"links": [ ]
}
},
"Example Response 7": {"meta": {"status": 401,
"code": "ERR-401-TrialExceeded",
"title": "Bad Billing Status Error",
"message": "Your billing status needs attention. You can't start or add live streams until your billing status is updated.",
"description": "",
"links": [ ]
}
},
"Example Response 8": {"meta": {"status": 401,
"code": "ERR-401-ExpiredToken",
"title": "JWT is expired",
"message": "Token has exired.",
"description": "",
"links": [ ]
}
},
"Example Response 9": {"meta": {"status": 401,
"code": "ERR-401-InvalidToken",
"title": "JWT is invalid",
"message": "Token is invalid.",
"description": "",
"links": [ ]
}
}
}

Restream an asset

This operation returns a live stream ID you can use to re-stream an uploaded asset.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the asset.

Responses

200

Success

Response Schema: application/json

id	string The unique alphanumeric string that identifies the live stream associated with the asset.
name	string A name for the live stream assosicated with the asset. This is generated by Wowza Video.

401

Unauthorized

422

Asset Not Available

post/assets/{id}/live_streams

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/beta/assets/2adffc17/live_streams"

Response samples

application/json

{"id": "",
"name": "CMS Restreamed (Yx6rTGKL)"
}

Fetch all asset tags

This operation retrieves a list of all of the tags that have been used previously by an organization.

Request

query Parameters

page	integer Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is 1. For more information and examples, see Get paginated query results with the Wowza Video REST API.
per_page	integer For use with the page parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is 1000.

Responses

200

Success

Response Schema: application/json

asset_tags

array

An array of asset tags the organization has created.

401

Unauthorized

get/asset_tags

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/beta/asset_tags"

Response samples

application/json

{"asset_tags": ["tag1",
"tag2",
"tag3"
]
}

Report asset as uploaded

This operation reports that an asset was successfully uploaded to Google storage.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the asset.

Request Body schema: application/json

Provide the details of the asset to update in the body of the request.

required

object (asset)

duration required	string <time> The length of an asset, in hours, minutes, and seconds.
file_size required	integer The file size of the asset.

Responses

200

Success

Response Schema: application/json

required

object (asset)

	Array of objects (renditions) The renditions available for the asset.
average_view_time	integer <time> The average time that the asset has been viewed.
created_at	string <date-time> The date and time that the asset was created.
description	string A description of the asset. Maximum 16,000 characters.
download_url	string The URL that can be used to download the asset as a .MP4 file.
duration	string <time> The length of an asset, in hours, minutes, and seconds.
file_name	string The name of the mp4 file you uploaded.
file_size	integer The file size of the asset.
id	string The unique alphanumeric string that identifies the asset
name	string A descriptive name for the live stream. Maximum 200 characters.
playback_enabled	boolean Specifies whether playback is enabled for an asset.
playback_url	string The HLS URL for the stream associated with the asset.
processing_percentage	integer A percentage that describes how soon transcoding will complete.
recording_id	string An ID for the recording. You can use this to fetch additional information about the recording associated with the asset.
state	string The state of the asset. Enum: "uploading" "processing" "completed" "failed"
tags	array A list of tags associated with the asset.
thumbnail_url	string The URL to receive the preview thumbnail.
total_storage_size	integer The total storage size for the asset.
total_viewing_time	integer The total time that the asset has been viewed by anyone.
updated_at	string <date-time> The date and time that the asset was updated.
unique_viewers	integer The number of unique viewers for the stream.
vod_stream_id	string An ID for the VOD. You can use this to fetch additional information about the VOD stream associated with the asset, such as the size of only the VOD stream.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

patch/assets/{id}/upload_completed

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"asset": {"duration": "",
"file_size": 2372820
}
}

Response samples

application/json

{"asset": {"available_renditions": [{"height": 480,
"width": 848,
"bitrate_kbps": 1600
}
],
"average_view_time": 44925498,
"created_at": "2021-06-30T18:02:20.000Z",
"description": "My Asset Description",
"download_url": "https://storage.googleapis.com/qa-wse-recordings/zjpfl9f7/recording_xcwvfkgy/MyAsset.mp4",
"duration": 30526,
"file_name": "MyAsset.mp4",
"file_size": 2372820,
"id": "i4qsbwvi",
"name": "My Asset",
"playback_enabled": true,
"playback_url": "https://cdn3-qa.wowza.com/2/T1R6V2hBV2hEdmJ0/ZnJUOE9q/hls/g7z7bwbz/playlist.m3u8",
"processing_percentage": 100,
"recording_id": "l8qsbwvu",
"state": "completed",
"tags": ["Tag1",
"Tag2",
"Tag3"
],
"thumbnail_url": "https://storage.googleapis.com/qa-wse-recordings/zjpfl9f7/recording_zwpjcrpf/thumbnail.jpg",
"total_storage_size": 19513598,
"total_viewing_time": 44925498,
"updated_at": "2021-06-30T18:02:20.000Z",
"unique_viewers": 5986,
"vod_stream_id": "l9qsbwvf"
}
}

Report asset upload as failed

This operation reports that an asset uploaded to Google storage failed.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the asset.

Request Body schema: application/json

Provide the details of the asset to update in the body of the request.

required

object (asset)

reason required	string A description of why the upload failed.
status required	string The status code returned by the server.

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

patch/assets/{id}/upload_failed

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"asset": {"reason": "string",
"status": 404
}
}

Response samples

application/json

{"Example Response 1": {"meta": {"status": 401,
"code": "ERR-401-NoApiKey",
"title": "No API Key Error",
"message": "No API key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 2": {"meta": {"status": 401,
"code": "ERR-401-NoAccessKey",
"title": "No Access Key Error",
"message": "No access key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 3": {"meta": {"status": 401,
"code": "ERR-401-InvalidApiKey",
"title": "Invalid Api Key Error",
"message": "Invalid API key.",
"description": "",
"links": [ ]
}
},
"Example Response 4": {"meta": {"status": 401,
"code": "ERR-401-InvalidAccessKey",
"title": "Invalid Access Key Error",
"message": "Invalid access key.",
"description": "",
"links": [ ]
}
},
"Example Response 5": {"meta": {"status": 401,
"code": "ERR-401-BadAccountStatus",
"title": "Bad Account Status Error",
"message": "Your account's status doesn't allow this action.",
"description": "",
"links": [ ]
}
},
"Example Response 6": {"meta": {"status": 401,
"code": "ERR-401-FeatureNotEnabled",
"title": "Feature Not Enabled Error",
"message": "This feature isn't enabled.",
"description": "",
"links": [ ]
}
},
"Example Response 7": {"meta": {"status": 401,
"code": "ERR-401-TrialExceeded",
"title": "Bad Billing Status Error",
"message": "Your billing status needs attention. You can't start or add live streams until your billing status is updated.",
"description": "",
"links": [ ]
}
},
"Example Response 8": {"meta": {"status": 401,
"code": "ERR-401-ExpiredToken",
"title": "JWT is expired",
"message": "Token has exired.",
"description": "",
"links": [ ]
}
},
"Example Response 9": {"meta": {"status": 401,
"code": "ERR-401-InvalidToken",
"title": "JWT is invalid",
"message": "Token is invalid.",
"description": "",
"links": [ ]
}
}
}