GET
/
task
curl --request GET \
  --url https://livepeer.studio/api/task \
  --header 'Authorization: Bearer <api-key>'
[
  {
    "id": "09F8B46C-61A0-4254-9875-F71F4C605BC7",
    "type": "upload",
    "createdAt": 1587667174725,
    "scheduledAt": 1587667174725,
    "inputAssetId": "09F8B46C-61A0-4254-9875-F71F4C605BC7",
    "outputAssetId": "09F8B46C-61A0-4254-9875-F71F4C605BC7",
    "requesterId": "09F8B46C-61A0-4254-9875-F71F4C605BC7",
    "params": {
      "upload": {
        "url": "https://cdn.livepeer.com/ABC123/filename.mp4",
        "encryption": {},
        "c2pa": true,
        "profiles": [
          {
            "width": 1280,
            "name": "720p",
            "height": 129,
            "bitrate": 3000000,
            "quality": 23,
            "fps": 30,
            "fpsDen": 1,
            "gop": 2,
            "profile": "H264Baseline",
            "encoder": "H.264"
          }
        ],
        "targetSegmentSizeSecs": 6
      },
      "export": {
        "custom": {
          "url": "https://s3.amazonaws.com/my-bucket/path/filename.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=LLMMB",
          "method": "POST",
          "headers": {}
        }
      },
      "exportData": {
        "content": {
          "data": "Hello, World!"
        },
        "ipfs": {
          "pinata": {},
          "nftMetadataTemplate": "file",
          "nftMetadata": {}
        },
        "type": "text/plain",
        "id": "09F8B46C-61A0-4254-9875-F71F4C605BC7"
      },
      "transcode-file": {
        "input": {
          "url": "https://cdn.livepeer.com/ABC123/filename.mp4"
        },
        "storage": {
          "url": "s3+https://accessKeyId:secretAccessKey@s3Endpoint/bucket"
        },
        "outputs": {
          "hls": {
            "path": "/samplevideo/hls"
          },
          "mp4": {
            "path": "/samplevideo/mp4"
          }
        },
        "profiles": [
          {
            "width": 1280,
            "name": "720p",
            "height": 129,
            "bitrate": 3000000,
            "quality": 23,
            "fps": 30,
            "fpsDen": 1,
            "gop": 2,
            "profile": "H264Baseline",
            "encoder": "H.264"
          }
        ],
        "targetSegmentSizeSecs": 10,
        "creatorId": {
          "type": "unverified",
          "value": "<string>"
        },
        "c2pa": true
      },
      "clip": {
        "url": "https://asset-cdn.lp-playback.monster/hls/1bde4o2i6xycudoy/static360p0.mp4",
        "clipStrategy": {
          "startTime": 1587667174725,
          "endTime": 1587667174725,
          "playbackId": "eaw4nk06ts2d0mzb"
        },
        "catalystPipelineStrategy": "catalyst_ffmpeg",
        "sessionId": "d32ae9e6-c459-4931-9898-e86e2f5e7e16",
        "inputId": "09F8B46C-61A0-4254-9875-F71F4C605BC7"
      }
    },
    "status": {
      "phase": "pending",
      "updatedAt": 1587667174725,
      "progress": 0.5,
      "errorMessage": "Failed to upload file",
      "retries": 3
    },
    "output": {
      "upload": {
        "assetSpec": {
          "id": "09F8B46C-61A0-4254-9875-F71F4C605BC7",
          "type": "video",
          "playbackId": "eaw4nk06ts2d0mzb",
          "userId": "66E2161C-7670-4D05-B71D-DA2D6979556F",
          "playbackUrl": "https://livepeercdn.com/asset/ea03f37e-f861-4cdd-b495-0e60b6d753ad/index.m3u8",
          "downloadUrl": "https://livepeercdn.com/asset/eaw4nk06ts2d0mzb/video",
          "playbackPolicy": {
            "type": "webhook",
            "webhookId": "1bde4o2i6xycudoy",
            "webhookContext": {
              "streamerId": "my-custom-id"
            },
            "refreshInterval": 600
          },
          "source": {
            "type": "url",
            "url": "<string>",
            "gatewayUrl": "<string>",
            "encryption": {}
          },
          "creatorId": {
            "type": "unverified",
            "value": "user123"
          },
          "storage": {
            "ipfs": {
              "spec": {
                "nftMetadataTemplate": "file",
                "nftMetadata": {}
              },
              "nftMetadata": {
                "cid": "<string>",
                "url": "<string>",
                "gatewayUrl": "<string>"
              },
              "updatedAt": 1587667174725,
              "cid": "<string>",
              "url": "<string>",
              "gatewayUrl": "<string>"
            },
            "status": {
              "phase": "ready",
              "progress": 0.5,
              "errorMessage": "Failed to update storage",
              "tasks": {
                "pending": "09F8B46C-61A0-4254-9875-F71F4C605BC7",
                "last": "09F8B46C-61A0-4254-9875-F71F4C605BC7",
                "failed": "09F8B46C-61A0-4254-9875-F71F4C605BC7"
              }
            }
          },
          "status": {
            "phase": "uploading",
            "updatedAt": 1587667174725,
            "progress": 123,
            "errorMessage": "<string>"
          },
          "name": "filename.mp4",
          "projectId": "aac12556-4d65-4d34-9fb6-d1f0985eb0a9",
          "createdAt": 1587667174725,
          "createdByTokenName": "<string>",
          "size": 84934509,
          "hash": [
            {
              "hash": "9b560b28b85378a5004117539196ab24e21bbd75b0e9eb1a8bc7c5fd80dc5b57",
              "algorithm": "sha256"
            }
          ],
          "videoSpec": {
            "format": "mp4",
            "duration": 23.8328,
            "bitrate": 1000000,
            "tracks": [
              {
                "type": "video",
                "codec": "aac",
                "startTime": 23.8238,
                "duration": 23.8238,
                "bitrate": 1000000,
                "width": 1920,
                "height": 1080,
                "pixelFormat": "yuv420p",
                "fps": 30,
                "channels": 2,
                "sampleRate": 44100,
                "bitDepth": 16
              }
            ]
          }
        }
      },
      "export": {
        "ipfs": {
          "videoFileCid": "Qmabc123xyz341",
          "videoFileUrl": "ipfs://Qmabc123xyz341",
          "videoFileGatewayUrl": "https://gateway.ipfs.io/ipfs/Qmabc123xyz341",
          "nftMetadataCid": "Qmabc123xyz341",
          "nftMetadataUrl": "ipfs://Qmabc123xyz341",
          "nftMetadataGatewayUrl": "https://gateway.ipfs.io/ipfs/Qmabc123xyz341"
        }
      },
      "exportData": {
        "ipfs": {
          "cid": "Qmabc123xyz341"
        }
      }
    }
  }
]

Authorizations

Authorization
string
headerrequired

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

Response

200 - application/json
id
string

Task ID

type
enum<string>

Type of the task

Available options:
upload,
export,
export-data,
transcode-file,
clip
createdAt
number

Timestamp (in milliseconds) at which task was created

scheduledAt
number

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

inputAssetId
string

ID of the input asset

outputAssetId
string

ID of the output asset

requesterId
string

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

params
object

Parameters of the task

status
object

Status of the task

output
object

Output of the task