- Documentation
- API Reference
- Livepeer Dev Kit
- Catalyst
- What's New
- Community
Asset
Livestream
Multistream target
Session
Access control
Webhook
Task
Playback
Transcode
Viewership
APIs
Retrieve Playback Info
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
The playback ID from the asset or livestream, e.g. eaw4nk06ts2d0mzb
.
curl --request GET \
--url https://livepeer.studio/api/playback/{id} \
--header 'Authorization: Bearer <api-key>'
{
"type": "vod",
"meta": {
"live": 0,
"playbackPolicy": {
"type": "public",
"webhookId": "<string>",
"webhookContext": {},
"refreshInterval": 123
},
"source": [
{
"hrn": "MP4",
"type": "html5/video/mp4",
"url": "https://asset-cdn.lp-playback.monster/hls/1bde4o2i6xycudoy/static360p0.mp4",
"size": 494778,
"width": 204,
"height": 360,
"bitrate": 449890
}
],
"dvrPlayback": [
{
"hrn": "MP4",
"type": "html5/video/mp4",
"url": "https://asset-cdn.lp-playback.monster/hls/1bde4o2i6xycudoy/static360p0.mp4",
"error": "<string>"
}
],
"attestation": {
"id": "5b9e63bb-6fd0-4bea-aff2-cc5d4eb9cad0",
"primaryType": "VideoAttestation",
"domain": {
"name": "Verifiable Video",
"version": "1"
},
"message": {
"video": "<string>",
"attestations": [
{
"role": "<string>",
"address": "<string>"
}
],
"signer": "<string>",
"timestamp": 123
},
"signature": "<string>",
"createdAt": 123,
"signatureType": "eip712",
"storage": {
"ipfs": {
"updatedAt": 1587667174725,
"cid": "<string>",
"url": "<string>",
"gatewayUrl": "<string>"
},
"status": {
"phase": "waiting",
"progress": 123,
"errorMessage": "<string>",
"tasks": {
"pending": "<string>",
"last": "<string>",
"failed": "<string>"
}
}
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The playback ID from the asset or livestream, e.g. eaw4nk06ts2d0mzb
.
Response
live
, vod
, recording
0
, 1
Whether the playback policy for a asset or stream is public or signed
public
, jwt
, webhook
ID of the webhook to use for playback policy
User-defined webhook context
Interval (in seconds) at which the playback policy should be refreshed (default 600 seconds)
Human Readable Name
HLS (TS)
, MP4
, WebRTC (H264)
, FLV (H264)
, Thumbnail (JPEG)
, Thumbnails
html5/application/vnd.apple.mpegurl
, html5/video/mp4
, html5/video/h264
, video/x-flv
, image/jpeg
, text/vtt
HLS (TS)
html5/application/vnd.apple.mpegurl
Video Metadata EIP-712 primaryType
VideoAttestation
Video Metadata EIP-712 domain
Verifiable Video
1
Video Metadata EIP-712 message content
Video Metadata EIP-712 message signature
Timestamp (in milliseconds) at which the object was created
eip712
, flow
Timestamp (in milliseconds) at which IPFS export task was updated
CID of the file on IPFS
URL with IPFS scheme for the file
URL to access file via HTTP through an IPFS gateway
Phase of the asset storage
waiting
, processing
, ready
, failed
, reverted
Current progress of the task updating the storage.
Error message if the last storage changed failed.
ID of any currently running task that is exporting this asset to IPFS.
ID of the last task to run successfully, that created the currently saved data.
ID of the last task to fail execution.
curl --request GET \
--url https://livepeer.studio/api/playback/{id} \
--header 'Authorization: Bearer <api-key>'
{
"type": "vod",
"meta": {
"live": 0,
"playbackPolicy": {
"type": "public",
"webhookId": "<string>",
"webhookContext": {},
"refreshInterval": 123
},
"source": [
{
"hrn": "MP4",
"type": "html5/video/mp4",
"url": "https://asset-cdn.lp-playback.monster/hls/1bde4o2i6xycudoy/static360p0.mp4",
"size": 494778,
"width": 204,
"height": 360,
"bitrate": 449890
}
],
"dvrPlayback": [
{
"hrn": "MP4",
"type": "html5/video/mp4",
"url": "https://asset-cdn.lp-playback.monster/hls/1bde4o2i6xycudoy/static360p0.mp4",
"error": "<string>"
}
],
"attestation": {
"id": "5b9e63bb-6fd0-4bea-aff2-cc5d4eb9cad0",
"primaryType": "VideoAttestation",
"domain": {
"name": "Verifiable Video",
"version": "1"
},
"message": {
"video": "<string>",
"attestations": [
{
"role": "<string>",
"address": "<string>"
}
],
"signer": "<string>",
"timestamp": 123
},
"signature": "<string>",
"createdAt": 123,
"signatureType": "eip712",
"storage": {
"ipfs": {
"updatedAt": 1587667174725,
"cid": "<string>",
"url": "<string>",
"gatewayUrl": "<string>"
},
"status": {
"phase": "waiting",
"progress": 123,
"errorMessage": "<string>",
"tasks": {
"pending": "<string>",
"last": "<string>",
"failed": "<string>"
}
}
}
}
}
}