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

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
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/beta/assets"
Response samples
application/json
{}

Fetch an asset

This operation shows the details of a specific asset.

Request
path Parameters
id
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
// 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
{}

Update an asset

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

Request
path Parameters
id
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
application/json
{
  • "asset": {
    }
}
Response samples
application/json
{}

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
id
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
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": {
    },
  • "Example Response 2": {
    },
  • "Example Response 3": {
    },
  • "Example Response 4": {
    },
  • "Example Response 5": {
    },
  • "Example Response 6": {
    },
  • "Example Response 7": {
    },
  • "Example Response 8": {
    },
  • "Example Response 9": {
    }
}

Restream an asset

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

Request
path Parameters
id
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
// 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
// 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": [
    ]
}

Report asset as uploaded

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

Request
path Parameters
id
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
application/json
{
  • "asset": {
    }
}
Response samples
application/json
{}

Report asset upload as failed

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

Request
path Parameters
id
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
application/json
{
  • "asset": {
    }
}
Response samples
application/json
{
  • "Example Response 1": {
    },
  • "Example Response 2": {
    },
  • "Example Response 3": {
    },
  • "Example Response 4": {
    },
  • "Example Response 5": {
    },
  • "Example Response 6": {
    },
  • "Example Response 7": {
    },
  • "Example Response 8": {
    },
  • "Example Response 9": {
    }
}
Copyright © Wowza Video. All right reserved.