LightFlow API documentation (2.0.1)

Download OpenAPI specification:Download

For information about getting started, please see Lightflow Getting Started.

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Assets

An asset is a video, including the output formats used to watch it online and offline, and the set of optimizations applied to maximize the viewers quality of experience. The assets generated by LightFlow are ready to be streamed through Internet.

List assets

Return a paginated list of assets.

Authorizations:
query Parameters
pageIndex
number

Pagination page index

pageSize
number

Pagination page size

creationDateFrom
string

Created date from filter (ISO date format)

creationDateTo
string

Created date to filter (ISO date format)

features
string

Features filter (perceptual-quality, perceptual-quality-per-scene, content-moderation, archive-enrichment, taxonomy-classifier, face-recognition). Provided as comma-separated string values

status
string

Status filter (queued, running, error, finished, canceled). Provided as comma-separated string values

inputUrlPath
string

Input URL filter

uuid
string

Asset UUID filter

name
string

Name filter

referenceId
string

Reference ID filter

tags
string

Tags filter

label
string

Label filter

showDemo
string

If set to true, response includes assets from demo account

Responses

Request samples

var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
  
xhr.addEventListener('readystatechange', function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});
    
xhr.open('GET', '/assets');
xhr.setRequestHeader('Authorization', 'Bearer eyJh...');
xhr.setRequestHeader('Accept', 'application/json');
xhr.setRequestHeader('Content-Type', 'application/json');

xhr.send(data);

Response samples

Content type
application/json
{
  • "totalItems": 0,
  • "pageIndex": 0,
  • "pageSize": 0,
  • "pages": 0,
  • "items": [
    ]
}

Create an asset

Publish a new asset.

Authorizations:
Request Body schema: application/json
label
string

The asset will be tagged with a label. Usage and billing information for assets /reports/usage-metrics can be then filtered by the label (100 characters max).

priority
number
Default: 50

Priority of the asset processing to start. Value between 0 (lowest) to 100 (highest).

object

Asset configuration.

Array of objects[ items ]

List of callbacks that will be used to notify when the asset processing task is done.

object

Asset metadata.

Responses

Request samples

Content type
application/json
{
  • "label": "string",
  • "priority": 50,
  • "parameters": {
    },
  • "callbacks": [