Create a live input - Cloudflare

Creates a live input, and returns credentials that you or your users can use to stream live video to Cloudflare Stream.

Request

Path Params

account_identifier

string

required

Body Params application/json

defaultCreator

string

optional

Sets the creator ID asssociated with this live input.

meta

object (live_input_metadata)

optional

A user modifiable key-value store used to reference other systems of record for managing live inputs.

Example:

{"name":"test stream 1"}

recording

object (live_input_recording_settings)

optional

Records the input to a Cloudflare Stream video. Behavior depends on the mode. In most cases, the video will initially be viewable as a live video and transition to on-demand after a condition is satisfied.

Example:

{"mode":"off","requireSignedURLs":false,"timeoutSeconds":0}

allowedOrigins

array[string]

optional

Lists the origins allowed to display videos created with this input. Enter allowed origin domains in an array and use * for wildcard subdomains. An empty array allows videos to be viewed on any origin.

Example:

["example.com"]

mode

enum<string>

optional

Specifies the recording behavior for the live input. Set this value to off to prevent a recording. Set the value to automatic to begin a recording and transition to on-demand after Stream Live stops receiving input.

Allowed values:

offautomatic

Default:

off

Example:

automatic

requireSignedURLs

boolean

optional

Indicates if a video using the live input has the requireSignedURLs property set. Also enforces access controls on any video recording of the livestream with the live input.

Default:

false

Example:

true

timeoutSeconds

integer

optional

Determines the amount of time a live input configured in automatic mode should wait before a recording transitions from live to on-demand. 0 is recommended for most use cases and indicates the platform default should be used.

Default:

Example

{
    "defaultCreator": "string",
    "meta": {
        "name": "test stream 1"
    },
    "recording": {
        "mode": "off",
        "requireSignedURLs": false,
        "timeoutSeconds": 0
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Create a live input response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {},
    "success": true
}

🟢200Create a live input response failure