Overview
APIs
- Asset
- Livestream
- Generate
- Multistream target
- Session
- Access control
- Webhook
- Task
- Playback
- Transcode
- Viewership
Retrieve tasks
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
Task ID
Type of the task
upload, export, export-data, transcode-file, clip Timestamp (in milliseconds) at which task was created
Timestamp (in milliseconds) at which the task was scheduled for execution (e.g. after file upload finished).
ID of the input asset
ID of the output asset
ID of the project
ID of the requester hash(IP + SALT + PlaybackId)
Parameters of the task
Parameters for the upload task
URL of the asset to "upload"
Decides if the output video should include C2PA signature
x > 1281 - 500x > 128x > 400Restricts 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 > 0x > 1H264Baseline, H264Main, H264High, H264ConstrainedHigh H.264, HEVC, VP8, VP9 How many seconds the duration of each output segment should be
Parameters for the export task
custom URL parameters for the export task
Parameters for the export-data task
File content to store into IPFS
Optional type of content
Optional ID of the content
Parameters for the transcode-file task
Input video file to transcode
URL of a video to transcode, accepts object-store format "s3+https"
Storage for the output files
URL of the output storage, accepts object-store format "s3+https"
x > 1281 - 500x > 128x > 400Restricts 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 > 0x > 1H264Baseline, H264Main, H264High, H264ConstrainedHigh H.264, HEVC, VP8, VP9 How many seconds the duration of each output segment should be
Decides if the output video should include C2PA signature
URL of the asset to "clip"
Strategy to use for clipping the asset. If not specified, the default strategy that Catalyst is configured for will be used. This field only available for admin users, and is only used for E2E testing.
Force to use a specific strategy in the Catalyst pipeline. If not specified, the default strategy that Catalyst is configured for will be used. This field only available for admin users, and is only used for E2E testing.
catalyst, catalyst_ffmpeg, background_external, background_mist, fallback_external, external ID of the session
ID of the input asset or stream
Status of the task
Phase of the task
pending, waiting, running, failed, completed, cancelled Timestamp (in milliseconds) at which task was updated
Current progress of the task in a 0-1 ratio
Error message if the task failed
Number of retries done on the task
Output of the task
Output of the upload task
url URL from which the asset was uploaded.
Gateway URL from asset if parsed from provided URL on upload.
The name of the asset. This is not necessarily the filename - it can be a custom name or title.
Type of the asset.
video, audio The playback ID to use with the Playback Info endpoint to retrieve playback URLs.
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).
The URL to directly download the asset, e.g. https://livepeercdn.com/asset/eawrrk06ts2d0mzb/video. It is not recommended to use this for playback.
Whether the playback policy for an 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)
List of allowed origins for CORS playback (<scheme>://<hostname>:<port>, <scheme>://<hostname>)
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 > 1281 - 500x > 128x > 400Restricts 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 > 0x > 1H264Baseline, H264Main, H264High, H264ConstrainedHigh H.264, HEVC, VP8, VP9 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
Current progress of the task creating this asset.
Error message if the asset creation failed.
The ID of the project
Timestamp (in milliseconds) at which asset was created
Name of the token used to create this object
Size of the asset in bytes
Video metadata
Format of the asset
Duration of the asset in seconds (float)
Bitrate of the video in bits per second
List of tracks associated with the asset when the format contemplates them (e.g. mp4)
Output of the export task
IPFS CID of the exported video file
URL for the file with the IPFS protocol
URL to access file via HTTP through an IPFS gateway
IPFS CID of the default metadata exported for the video
URL for the metadata file with the IPFS protocol
URL to access metadata file via HTTP through an IPFS gateway
Was this page helpful?