Retrieve tasks - Livepeer Docs

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Success

string

Task ID

Example:

"09F8B46C-61A0-4254-9875-F71F4C605BC7"

type

enum<string>

Type of the task

Available options:

upload,

export,

export-data,

transcode-file,

clip

Example:

"upload"

createdAt

number

Timestamp (in milliseconds) at which task was created

Example:

1587667174725

scheduledAt

number

Timestamp (in milliseconds) at which the task was scheduled for execution (e.g. after file upload finished).

Example:

1587667174725

inputAssetId

string

ID of the input asset

Example:

"09F8B46C-61A0-4254-9875-F71F4C605BC7"

outputAssetId

string

ID of the output asset

Example:

"09F8B46C-61A0-4254-9875-F71F4C605BC7"

projectId

string

ID of the project

Example:

"09F8B46C-61A0-4254-9875-F71F4C605BC7"

requesterId

string

ID of the requester hash(IP + SALT + PlaybackId)

Example:

"09F8B46C-61A0-4254-9875-F71F4C605BC7"

params

object

Parameters of the task

Show child attributes

params.upload

object

Parameters for the upload task

Show child attributes

params.upload.url

string

URL of the asset to "upload"

Example:

"https://cdn.livepeer.com/ABC123/filename.mp4"

params.upload.encryption

any

params.upload.c2pa

boolean

Decides if the output video should include C2PA signature

Example:

true

params.upload.profiles

object[]

Show child attributes

params.upload.profiles.bitrate

integer

required

Required range: x >= 400

Example:

3000000

params.upload.profiles.width

integer

Required range: x >= 128

Example:

1280

params.upload.profiles.name

string

Required string length: 1 - 500

Example:

"720p"

params.upload.profiles.height

integer

Required range: x >= 128

Example:

720

params.upload.profiles.quality

integer

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.

Required range: 0 <= x <= 44

Example:

23

params.upload.profiles.fps

integer

Required range: x >= 0

Example:

30

params.upload.profiles.fpsDen

integer

Required range: x >= 1

Example:

1

params.upload.profiles.gop

string

Example:

2

params.upload.profiles.profile

enum<string>

Available options:

H264Baseline,

H264Main,

H264High,

H264ConstrainedHigh

Example:

"H264Baseline"

params.upload.profiles.encoder

enum<string>

Available options:

H.264,

HEVC,

VP8,

VP9

Example:

"H.264"

params.upload.targetSegmentSizeSecs

number

How many seconds the duration of each output segment should be

Example:

6

params.export

object

Parameters for the export task

Option 1
Option 2

Show child attributes

params.export.custom

object

required

custom URL parameters for the export task

Show child attributes

params.export.custom.url

string<uri>

required

URL where to export the asset

Example:

"https://s3.amazonaws.com/my-bucket/path/filename.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=LLMMB"

params.export.custom.method

string

default:PUT

Method to use on the export request

Example:

"POST"

params.export.custom.headers

object

Headers to add to the export request

Show child attributes

params.export.custom.headers.{key}

string

params.exportData

object

Parameters for the export-data task

Show child attributes

params.exportData.content

object

required

File content to store into IPFS

Example:

{ "data": "Hello, World!" }

params.exportData.ipfs

object

Show child attributes

params.exportData.ipfs.pinata

object

Custom credentials for the Piñata service. Must have either a JWT or an API key and an API secret.

Option 1
Option 2

params.exportData.type

string

Optional type of content

Example:

"text/plain"

params.exportData.id

string

Optional ID of the content

Example:

"09F8B46C-61A0-4254-9875-F71F4C605BC7"

params.transcode-file

object

Parameters for the transcode-file task

Show child attributes

params.transcode-file.input

object

Input video file to transcode

Show child attributes

params.transcode-file.input.url

string

URL of a video to transcode, accepts object-store format "s3+https"

Example:

"https://cdn.livepeer.com/ABC123/filename.mp4"

params.transcode-file.storage

object

Storage for the output files

Show child attributes

params.transcode-file.storage.url

string

URL of the output storage, accepts object-store format "s3+https"

Example:

"s3+https://accessKeyId:secretAccessKey@s3Endpoint/bucket"

params.transcode-file.outputs

object

Output formats

Show child attributes

params.transcode-file.outputs.hls

object

HLS output format

Show child attributes

params.transcode-file.outputs.hls.path

string

Path for the HLS output

Example:

"/samplevideo/hls"

params.transcode-file.outputs.mp4

object

MP4 output format

Show child attributes

params.transcode-file.outputs.mp4.path

string

Path for the MP4 output

Example:

"/samplevideo/mp4"

params.transcode-file.profiles

object[]

Show child attributes

params.transcode-file.profiles.bitrate

integer

required

Required range: x >= 400

Example:

3000000

params.transcode-file.profiles.width

integer

Required range: x >= 128

Example:

1280

params.transcode-file.profiles.name

string

Required string length: 1 - 500

Example:

"720p"

params.transcode-file.profiles.height

integer

Required range: x >= 128

Example:

720

params.transcode-file.profiles.quality

integer

Required range: 0 <= x <= 44

Example:

23

params.transcode-file.profiles.fps

integer

Required range: x >= 0

Example:

30

params.transcode-file.profiles.fpsDen

integer

Required range: x >= 1

Example:

1

params.transcode-file.profiles.gop

string

Example:

2

params.transcode-file.profiles.profile

enum<string>

Available options:

H264Baseline,

H264Main,

H264High,

H264ConstrainedHigh

Example:

"H264Baseline"

params.transcode-file.profiles.encoder

enum<string>

Available options:

H.264,

HEVC,

VP8,

VP9

Example:

"H.264"

params.transcode-file.targetSegmentSizeSecs

number

How many seconds the duration of each output segment should be

Example:

10

params.transcode-file.creatorId

Show child attributes

params.transcode-file.creatorId.type

enum<string>

required

Available options:

unverified

params.transcode-file.creatorId.value

string

required

params.transcode-file.c2pa

boolean

Decides if the output video should include C2PA signature

Example:

false

params.clip

object

Show child attributes

params.clip.url

string

URL of the asset to "clip"

Example:

"https://asset-cdn.lp-playback.monster/hls/1bde4o2i6xycudoy/static360p0.mp4"

params.clip.clipStrategy

object

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.

Show child attributes

params.clip.clipStrategy.startTime

any

params.clip.clipStrategy.endTime

any

params.clip.clipStrategy.playbackId

any

params.clip.catalystPipelineStrategy

enum<string>

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.

Available options:

catalyst,

catalyst_ffmpeg,

background_external,

background_mist,

fallback_external,

external

Example:

"catalyst_ffmpeg"

params.clip.sessionId

string

ID of the session

Example:

"d32ae9e6-c459-4931-9898-e86e2f5e7e16"

params.clip.inputId

string

ID of the input asset or stream

Example:

"09F8B46C-61A0-4254-9875-F71F4C605BC7"

status

object

Status of the task

Show child attributes

status.phase

enum<string>

required

Phase of the task

Available options:

pending,

waiting,

running,

failed,

completed,

cancelled

Example:

"pending"

status.updatedAt

number

required

Timestamp (in milliseconds) at which task was updated

Example:

1587667174725

status.progress

number

Current progress of the task in a 0-1 ratio

Example:

0.5

status.errorMessage

string

Error message if the task failed

Example:

"Failed to upload file"

status.retries

number

Number of retries done on the task

Example:

3

output

object

Output of the task

Show child attributes

output.upload

object

Output of the upload task

Show child attributes

output.upload.assetSpec

object

Show child attributes

output.upload.assetSpec.id

string

required

Example:

"09F8B46C-61A0-4254-9875-F71F4C605BC7"

output.upload.assetSpec.source

object

required

Option 1
Option 2
Option 3

Show child attributes

output.upload.assetSpec.source.type

enum<string>

required

Available options:

url

output.upload.assetSpec.source.url

string

required

URL from which the asset was uploaded.

output.upload.assetSpec.source.gatewayUrl

string

Gateway URL from asset if parsed from provided URL on upload.

output.upload.assetSpec.source.encryption

any

output.upload.assetSpec.name

string

required

The name of the asset. This is not necessarily the filename - it can be a custom name or title.

Example:

"filename.mp4"

output.upload.assetSpec.type

enum<string>

Type of the asset.

Available options:

video,

audio

Example:

"video"

output.upload.assetSpec.playbackId

string

The playback ID to use with the Playback Info endpoint to retrieve playback URLs.

Example:

"eaw4nk06ts2d0mzb"

output.upload.assetSpec.userId

string

deprecated

Example:

"66E2161C-7670-4D05-B71D-DA2D6979556F"

output.upload.assetSpec.playbackUrl

string

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).

Example:

"https://livepeercdn.com/asset/ea03f37e-f861-4cdd-b495-0e60b6d753ad/index.m3u8"

output.upload.assetSpec.downloadUrl

string

The URL to directly download the asset, e.g. https://livepeercdn.com/asset/eawrrk06ts2d0mzb/video. It is not recommended to use this for playback.

Example:

"https://livepeercdn.com/asset/eaw4nk06ts2d0mzb/video/download.mp4"

output.upload.assetSpec.playbackPolicy

object

Whether the playback policy for an asset or stream is public or signed

Show child attributes

output.upload.assetSpec.playbackPolicy.type

enum<string>

required

Available options:

public,

jwt,

webhook

Example:

"webhook"

output.upload.assetSpec.playbackPolicy.webhookId

string

ID of the webhook to use for playback policy

Example:

"1bde4o2i6xycudoy"

output.upload.assetSpec.playbackPolicy.webhookContext

object

User-defined webhook context

Example:

{ "streamerId": "my-custom-id" }

output.upload.assetSpec.playbackPolicy.refreshInterval

number

Interval (in seconds) at which the playback policy should be refreshed (default 600 seconds)

Example:

600

output.upload.assetSpec.playbackPolicy.allowedOrigins

string[]

List of allowed origins for CORS playback (://:, ://)

output.upload.assetSpec.creatorId

object

Show child attributes

output.upload.assetSpec.creatorId.type

enum<string>

required

Available options:

unverified

Example:

"unverified"

output.upload.assetSpec.creatorId.value

string

required

Developer-managed ID of the user who created the resource.

Example:

"user123"

output.upload.assetSpec.profiles

object[]

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.

Show child attributes

output.upload.assetSpec.profiles.bitrate

integer

required

Required range: x >= 400

Example:

3000000

output.upload.assetSpec.profiles.width

integer

Required range: x >= 128

Example:

1280

output.upload.assetSpec.profiles.name

string

Required string length: 1 - 500

Example:

"720p"

output.upload.assetSpec.profiles.height

integer

Required range: x >= 128

Example:

720

output.upload.assetSpec.profiles.quality

integer

Required range: 0 <= x <= 44

Example:

23

output.upload.assetSpec.profiles.fps

integer

Required range: x >= 0

Example:

30

output.upload.assetSpec.profiles.fpsDen

integer

Required range: x >= 1

Example:

1

output.upload.assetSpec.profiles.gop

string

Example:

2

output.upload.assetSpec.profiles.profile

enum<string>

Available options:

H264Baseline,

H264Main,

H264High,

H264ConstrainedHigh

Example:

"H264Baseline"

output.upload.assetSpec.profiles.encoder

enum<string>

Available options:

H.264,

HEVC,

VP8,

VP9

Example:

"H.264"

output.upload.assetSpec.storage

object

Show child attributes

output.upload.assetSpec.storage.ipfs

object

Show child attributes

output.upload.assetSpec.storage.ipfs.spec

object

Show child attributes

output.upload.assetSpec.storage.ipfs.spec.nftMetadataTemplate

enum<string>

default:file

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.

Available options:

file,

player

output.upload.assetSpec.storage.ipfs.spec.nftMetadata

object

Additional data to add to the NFT metadata exported to IPFS. Will be deep merged with the default metadata exported.

output.upload.assetSpec.storage.ipfs.nftMetadata

object

Show child attributes

output.upload.assetSpec.storage.ipfs.nftMetadata.cid

string

required

CID of the file on IPFS

output.upload.assetSpec.storage.ipfs.nftMetadata.url

string

URL with IPFS scheme for the file

output.upload.assetSpec.storage.ipfs.nftMetadata.gatewayUrl

string

URL to access file via HTTP through an IPFS gateway

output.upload.assetSpec.storage.ipfs.updatedAt

number

Timestamp (in milliseconds) at which IPFS export task was updated

Example:

1587667174725

output.upload.assetSpec.storage.status

object

Show child attributes

output.upload.assetSpec.storage.status.phase

enum<string>

required

Phase of the asset storage

Available options:

waiting,

processing,

ready,

failed,

reverted

Example:

"ready"

output.upload.assetSpec.storage.status.tasks

object

required

Show child attributes

output.upload.assetSpec.storage.status.tasks.pending

string

ID of any currently running task that is exporting this asset to IPFS.

Example:

"09F8B46C-61A0-4254-9875-F71F4C605BC7"

output.upload.assetSpec.storage.status.tasks.last

string

ID of the last task to run successfully, that created the currently saved data.

Example:

"09F8B46C-61A0-4254-9875-F71F4C605BC7"

output.upload.assetSpec.storage.status.tasks.failed

string

ID of the last task to fail execution.

Example:

"09F8B46C-61A0-4254-9875-F71F4C605BC7"

output.upload.assetSpec.storage.status.progress

number

Current progress of the task updating the storage.

Example:

0.5

output.upload.assetSpec.storage.status.errorMessage

string

Error message if the last storage changed failed.

Example:

"Failed to update storage"

output.upload.assetSpec.status

object

Status of the asset

Show child attributes

output.upload.assetSpec.status.phase

enum<string>

required

Phase of the asset

Available options:

uploading,

waiting,

processing,

ready,

failed,

deleting,

deleted

output.upload.assetSpec.status.updatedAt

number

required

Timestamp (in milliseconds) at which the asset was last updated

Example:

1587667174725

output.upload.assetSpec.status.progress

number

Current progress of the task creating this asset.

output.upload.assetSpec.status.errorMessage

string

Error message if the asset creation failed.

output.upload.assetSpec.projectId

string

The ID of the project

Example:

"aac12556-4d65-4d34-9fb6-d1f0985eb0a9"

output.upload.assetSpec.createdAt

number

Timestamp (in milliseconds) at which asset was created

Example:

1587667174725

output.upload.assetSpec.createdByTokenName

string

Name of the token used to create this object

output.upload.assetSpec.size

number

Size of the asset in bytes

Example:

84934509

output.upload.assetSpec.hash

object[] | null

Hash of the asset

Show child attributes

output.upload.assetSpec.hash.hash

string

Hash of the asset

Example:

"9b560b28b85378a5004117539196ab24e21bbd75b0e9eb1a8bc7c5fd80dc5b57"

output.upload.assetSpec.hash.algorithm

string

Hash algorithm used to compute the hash

Example:

"sha256"

output.upload.assetSpec.videoSpec

object

Video metadata

Show child attributes

output.upload.assetSpec.videoSpec.format

string

Format of the asset

Example:

"mp4"

output.upload.assetSpec.videoSpec.duration

number

Duration of the asset in seconds (float)

Example:

23.8328

output.upload.assetSpec.videoSpec.bitrate

number

Bitrate of the video in bits per second

Example:

1000000

output.upload.assetSpec.videoSpec.tracks

object[]

List of tracks associated with the asset when the format contemplates them (e.g. mp4)

Show child attributes

output.upload.assetSpec.videoSpec.tracks.type

enum<string>

required

type of track

Available options:

video,

audio

Example:

"video"

output.upload.assetSpec.videoSpec.tracks.codec

string

required

Codec of the track

Example:

"aac"

output.upload.assetSpec.videoSpec.tracks.startTime

number

Start time of the track in seconds

Example:

23.8238

output.upload.assetSpec.videoSpec.tracks.duration

number

Duration of the track in seconds

Example:

23.8238

output.upload.assetSpec.videoSpec.tracks.bitrate

number

Bitrate of the track in bits per second

Example:

1000000

output.upload.assetSpec.videoSpec.tracks.width

number

Width of the track - only for video tracks

Example:

1920

output.upload.assetSpec.videoSpec.tracks.height

number

Height of the track - only for video tracks

Example:

1080

output.upload.assetSpec.videoSpec.tracks.pixelFormat

string

Pixel format of the track - only for video tracks

Example:

"yuv420p"

output.upload.assetSpec.videoSpec.tracks.fps

number

Frame rate of the track - only for video tracks

Example:

30

output.upload.assetSpec.videoSpec.tracks.channels

number

Amount of audio channels in the track

Example:

2

output.upload.assetSpec.videoSpec.tracks.sampleRate

number

Sample rate of the track in samples per second - only for audio tracks

Example:

44100

output.upload.assetSpec.videoSpec.tracks.bitDepth

number

Bit depth of the track - only for audio tracks

Example:

16

output.export

object

Output of the export task

Show child attributes

output.export.ipfs

object

Show child attributes

output.export.ipfs.videoFileCid

string

required

IPFS CID of the exported video file

Example:

"Qmabc123xyz341"

output.export.ipfs.videoFileUrl

string

URL for the file with the IPFS protocol

Example:

"ipfs://Qmabc123xyz341"

output.export.ipfs.videoFileGatewayUrl

string

URL to access file via HTTP through an IPFS gateway

Example:

"https://gateway.ipfs.io/ipfs/Qmabc123xyz341"

output.export.ipfs.nftMetadataCid

string

IPFS CID of the default metadata exported for the video

Example:

"Qmabc123xyz341"

output.export.ipfs.nftMetadataUrl

string

URL for the metadata file with the IPFS protocol

Example:

"ipfs://Qmabc123xyz341"

output.export.ipfs.nftMetadataGatewayUrl

string

URL to access metadata file via HTTP through an IPFS gateway

Example:

"https://gateway.ipfs.io/ipfs/Qmabc123xyz341"

output.exportData

object

Output of the export data task

Show child attributes

output.exportData.ipfs

object

Show child attributes

output.exportData.ipfs.cid

string

required

IPFS CID of the exported data

Example:

"Qmabc123xyz341"

Overview

APIs

Authorizations

Response