Create input

post

https://api.videoflow.io/1.0/inputs

Create a new input in the CMS

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

type

string

enum

required

Defaults to custom

An input can be live stream, ultra low latency live stream or a custom asset

Allowed:

name

string

required

Defaults to New Input

The name of the input as it will be shown in the CMS

state

string

enum

Defaults to na

The state of the video

Allowed:

sources

array of objects

required

Array of sources

sources*

captions

string

A URL the a VTT recourse that will be used as the captions when the input source is played back

description

string

The description of the input as it will be displayed in the CMS

thumbnail

string

The URL for the thumbnail of the input. Thumbnail can be used to present the input in a channel or later on in your own platform

tags

array of strings

The array of string that represent a list of tags by which the CMS can group, select and target the content

tags

metadata

json

The metadata is a raw JSON that contains additional information about this input. Use this property to add custom data that later can be used to segment and create custom actions driven by this input

start_time

date

The start date and time of the event in this video (if applicable). This property is used for display and sorting. It doesn't not affect any functionality of availability of the content

end_time

date

The end date and time of the event in this video (if applicable). This property is used for display and sorting. It doesn't not affect any functionality of availability of the content

workspace

string

The id of the workspace to witch this input will be assigned. If no workspace id was provided the input will be assigned to the default workspace of the user submitting this request. If you have only one workspace, this property is not needed

group

string

An arbitrary ID that defines a group of inputs

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json