Overview
APIs
- Asset
- Livestream
- Generate
- Multistream target
- Session
- Access control
- Webhook
- Task
- Playback
- Transcode
- Viewership
Upload asset via URL
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
URL where the asset contents can be retrieved, e.g. https://s3.amazonaws.com/my-bucket/path/filename.mp4.
For an IPFS source, this should be similar to: ipfs://{CID}. For an Arweave
source: ar://{CID}.
Whether the playback policy for an asset or stream is public or signed
public, jwt, webhook List of allowed origins for CORS playback (<scheme>://<hostname>:<port>, <scheme>://<hostname>)
Interval (in seconds) at which the playback policy should be refreshed (default 600 seconds)
User-defined webhook context
ID of the webhook to use for playback policy
Response
The name of the asset. This is not necessarily the filename - it can be a custom name or title.
Timestamp (in milliseconds) at which asset was created
Name of the token used to create this object
The URL to directly download the asset, e.g. https://livepeercdn.com/asset/eawrrk06ts2d0mzb/video. It is not recommended to use this for playback.
The playback ID to use with the Playback Info endpoint to retrieve playback URLs.
Whether the playback policy for an asset or stream is public or signed
public, jwt, webhook List of allowed origins for CORS playback (<scheme>://<hostname>:<port>, <scheme>://<hostname>)
Interval (in seconds) at which the playback policy should be refreshed (default 600 seconds)
User-defined webhook context
ID of the webhook to use for playback policy
URL for HLS playback. It is recommended to not use this URL, and instead use playback IDs with the Playback Info endpoint to retrieve the playback URLs - this URL format is subject to change (e.g. https://livepeercdn.com/asset/ea03f37e-f861-4cdd-b495-0e60b6d753ad/index.m3u8).
Requested profiles for the asset to be transcoded into. Configured
on the upload APIs payload or through the stream.recordingSpec
field for recordings. If not specified, default profiles are derived
based on the source input. If this is a recording, the source will
not be present in this list but will be available for playback.
x > 400H.264, HEVC, VP8, VP9 x > 0x > 1x > 1281 - 500H264Baseline, H264Main, H264High, H264ConstrainedHigh Restricts the size of the output video using the constant quality feature. Increasing this value will result in a lower quality video. Note that this parameter might not work if the transcoder lacks support for it.
0 < x < 44x > 128The ID of the project
Size of the asset in bytes
Status of the asset
Phase of the asset
uploading, waiting, processing, ready, failed, deleting, deleted Timestamp (in milliseconds) at which the asset was last updated
Error message if the asset creation failed.
Current progress of the task creating this asset.
Additional data to add to the NFT metadata exported to IPFS. Will be deep merged with the default metadata exported.
Name of the NFT metadata template to export. 'player' will embed the Livepeer Player on the NFT while 'file' will reference only the immutable MP4 files.
file, player Timestamp (in milliseconds) at which IPFS export task was updated
Phase of the asset storage
waiting, processing, ready, failed, reverted ID of the last task to fail execution.
ID of the last task to run successfully, that created the currently saved data.
ID of any currently running task that is exporting this asset to IPFS.
Error message if the last storage changed failed.
Current progress of the task updating the storage.
Type of the asset.
video, audio Video metadata
Bitrate of the video in bits per second
Duration of the asset in seconds (float)
Format of the asset
List of tracks associated with the asset when the format contemplates them (e.g. mp4)
Codec of the track
type of track
video, audio Bit depth of the track - only for audio tracks
Bitrate of the track in bits per second
Amount of audio channels in the track
Duration of the track in seconds
Frame rate of the track - only for video tracks
Height of the track - only for video tracks
Pixel format of the track - only for video tracks
Sample rate of the track in samples per second - only for audio tracks
Start time of the track in seconds
Width of the track - only for video tracks
Was this page helpful?