Get all inputs from the CMS

Return an array of Input objects. Each Input object carries information about the Input and the underlying video source associated with each input. When you create a new input and get an existing input the following object will be returned.

Property

Type

Description

id

string

The unique id of this object. this property should be used to query, modify, or delete this resource

type

[string]

The type of the input can be:
custom - A video source linked for an 3rd party CDN.
upload - Uploaded video
live - standard live stream via Videoflow.
ullLive - ultra low latency video delivered via Videoflow infrastructure.

state

[string]

The state of the video can be:
vod - Recorded video.
live - Currently live video.
scheduled - Scheduled video
na - Not applicable.

name

string

The name of the input.

description

string

The description of the input. This property is used to present additional information about the content of the input in channels and other 3rd party platforms.

visible

bool

The visibility property of the input. This will expose or hide the Input in the channel and change the property in the object in the API response

rating

number (integer)

The rating of the video, can be be a whole number between 1 and 5

featured

bool

Indicates where the input is marked as featured in the CMS

sources

array

Array of source objects. See the specification for the source object below.

group

string

Arbitrary ID that defines a group of inputs.

captions

string

The URL of the WebVTT resource to use as captions for the video content.

thumbnail

string

The URL of the thumbnail to use when presenting the input in the CMS, channels or 3rd party apps.

user

string

The id of the user that created this input.

organization_owner

string

The id of the user that owns the account in which the input was created.

created_time

string

The date / time when the input was created.

updated_time

string

The date / time when the input was last updated.

start_date

string

The date that the event in the video started (if applicable).

start_time

string

The time that event in the video started (if applicable).

end_date

string

The date that the event in the video ended (if applicable).

end_time

string

The time that the event in the video ended (if applicable).

workspaces

[string]

The list of the workspaces ids that the input belongs to.

Currency is limited to a single workflow per input, therefore the length of the array is always 1.

tags

[string]

The list of the tags associated with the input.

metadata

JSON

Custom JSON object with additional data about the input. The object can contain any legal JSON structure and data.

Refer to the Custom metadata documentation to learn more.

Source object

Each input can have zero or more sources. For example and input that is schedule to be live in the future might have no sources at all. A video file that was uploaded to the CMS via the UI will have a single source object. A multi camera source that was updated via the API might have multiple sources. Each source object has the following structure:

Property

Type

Description

id

string

The unique id of this object. this property should be used to query, modify, or delete this resource

name

string

The name of the current source. By default, it will be the same as the input name, but can be modified via the API to describe the specific URL. For example "Camera 1"

url

string

the url of the manifest for this source. If content was uploaded the url will be assigned automatically, but it can also be modified via the API.

metadata

JSON

A JSON object that describes additional information related to this source.

Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!