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.
This operation creates an asset.
Success
Unauthorized
Unprocessable Entity
{- "asset": {
- "file_name": "MyAsset.mp4"
}
}
{- "asset": {
- "created_at": "2021-06-30T18:02:20.000Z",
- "id": "2adffc17",
- "file_name": "MyAsset.mp4",
}
}
This operation shows limited details for all of your assets. For detailed information, fetch a single asset.
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. |
Success
required | Array of objects (assets) | ||||||||||||||||||||||||
Array
|
Unauthorized
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/beta/assets"
{- "assets": [
- {
- "created_at": "2020-01-29T17:16:21.849Z",
- "id": "wdjfqvsv",
- "name": "MyAsset",
- "playback_enabled": true,
- "processing_percentage": 0.1,
- "file_name": "MyFile.mp4",
- "file_size": 1570024,
- "state": "completed",
- "updated_at": "2020-01-31T16:06:47.849Z"
}, - {
- "created_at": "2020-01-29T17:16:21.849Z",
- "id": "KyxWKtHQ",
- "name": "MyAsset2",
- "playback_enabled": true,
- "processing_percentage": 0.3,
- "file_name": "MyFile2.mp4",
- "file_size": 70284,
- "state": "completed",
- "updated_at": "2020-01-31T02:26:05.849Z"
}, - {
- "created_at": "2020-01-29T17:16:21.849Z",
- "id": "Ly40ZDSg",
- "name": "MyAsset3",
- "playback_enabled": true,
- "processing_percentage": 0,
- "file_name": "MyFile3.mp4",
- "file_size": 882391,
- "state": "completed",
- "updated_at": "2020-01-30T18:13:18.849Z"
}
]
}
This operation shows the details of a specific asset.
Success
required | object (asset) | ||||||||||||||||||||||||||||||||||||||||||||
|
Unauthorized
Forbidden
Not Found
Gone
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/beta/assets/2adffc17"
{- "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",
- "duration": 30526,
- "file_name": "MyAsset.mp4",
- "file_size": 2372820,
- "id": "i4qsbwvi",
- "name": "My Asset",
- "playback_enabled": true,
- "processing_percentage": 100,
- "recording_id": "l8qsbwvu",
- "state": "completed",
- "tags": [
- "Tag1",
- "Tag2",
- "Tag3"
], - "total_storage_size": 19513598,
- "total_viewing_time": 44925498,
- "updated_at": "2021-06-30T18:02:20.000Z",
- "unique_viewers": 5986,
- "vod_stream_id": "l9qsbwvf"
}
}
This operation updates an asset. Assets must be uploaded and complete processing before they can be updated.
Provide the details of the asset to update in the body of the request.
required | object (asset) | ||||||||
|
Success
required | object (asset) | ||||||||||||||||||||||||||||||||||||||||||||
|
Unauthorized
Forbidden
Not Found
Gone
Asset Not Available
{- "asset": {
- "description": "My Asset Description",
- "name": "My Live Stream",
- "playback_enabled": true,
- "tags": [
- "Tag1",
- "Tag2",
- "Tag3"
]
}
}
{- "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",
- "duration": 30526,
- "file_name": "MyAsset.mp4",
- "file_size": 2372820,
- "id": "i4qsbwvi",
- "name": "My Asset",
- "playback_enabled": true,
- "processing_percentage": 100,
- "recording_id": "l8qsbwvu",
- "state": "completed",
- "tags": [
- "Tag1",
- "Tag2",
- "Tag3"
], - "total_storage_size": 19513598,
- "total_viewing_time": 44925498,
- "updated_at": "2021-06-30T18:02:20.000Z",
- "unique_viewers": 5986,
- "vod_stream_id": "l9qsbwvf"
}
}
This operation deletes an asset, including all assigned outputs and targets. Assets must have completed uploading and processing before they can be deleted.
No Content
Unauthorized
Forbidden
Not Found
Gone
Asset Not Available
curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/beta/assets/2adffc17"
{- "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": [ ]
}
}
}
This operation returns a live stream ID you can use to re-stream an uploaded asset.
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/beta/assets/2adffc17/live_streams"
{- "id": "",
- "name": "CMS Restreamed (Yx6rTGKL)"
}
This operation reports that an asset was successfully uploaded to Google storage.
Provide the details of the asset to update in the body of the request.
Success
required | object (asset) | ||||||||||||||||||||||||||||||||||||||||||||
|
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
{- "asset": {
- "duration": "",
- "file_size": 2372820
}
}
{- "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",
- "duration": 30526,
- "file_name": "MyAsset.mp4",
- "file_size": 2372820,
- "id": "i4qsbwvi",
- "name": "My Asset",
- "playback_enabled": true,
- "processing_percentage": 100,
- "recording_id": "l8qsbwvu",
- "state": "completed",
- "tags": [
- "Tag1",
- "Tag2",
- "Tag3"
], - "total_storage_size": 19513598,
- "total_viewing_time": 44925498,
- "updated_at": "2021-06-30T18:02:20.000Z",
- "unique_viewers": 5986,
- "vod_stream_id": "l9qsbwvf"
}
}
This operation reports that an asset uploaded to Google storage failed.
Provide the details of the asset to update in the body of the request.
No Content
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
{- "asset": {
- "reason": "string",
- "status": 404
}
}
{- "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": [ ]
}
}
}