Skip to main content
POST

Authorizations

Authorization
string
header
required

RSA-signed JWT token

Body

application/json
name
string
required
Required string length: 1 - 255
type
enum<string>
required

linear (24/7) or event (up to 6h)

Available options:
linear,
event
mode
enum<string>
required
Available options:
video,
audio
region
string
required

Region code, e.g. sg-edge-04, bd-edge-01.

ingest
object
required
output_protocols
enum<string>[]
required

dash not allowed when mode=audio.

Required array length: 1 - 2 elements
Available options:
hls,
dash
ladder
object
required

Provide video[] for mode=video (max 6 renditions) or audio[] for mode=audio (max 3 renditions). Mixing is rejected.

packaging
object
required

Per-protocol settings. hls required when output_protocols includes hls. dash required when output_protocols includes dash. dash is not allowed for mode=audio.

recording
object
webhook_url
string<uri>
meta
object

Custom key-value metadata

Response

Stream created

success
boolean
Example:

true

message
string
data
object