Skip to main content
POST
Create an HLS/DASH video stream

Authorizations

Authorization
string
header
required

Dashboard-generated Convertly API key. Keys currently begin with cvly_.

Body

application/json
sourceFileId
string<uuid>
required

Stored video file id from Convertly Storage.

profile
enum<string>
default:standard
Available options:
basic,
standard,
hd,
source_max,
custom
renditions
object[]

Required when profile is custom.

segmentDuration
integer
default:6
Required range: 2 <= x <= 12
access
enum<string>
default:signed
Available options:
public,
signed
clip
object
packageFormats
enum<string>[]

Packaging formats to generate. Include dash for DASH/CMAF output.

Required array length: 1 - 2 elements
Available options:
hls,
dash
videoCodec
enum<string>
default:h264

Video codec for the stream. H.264 can use the configured managed provider; AV1 routes through Convertly's built-in packager.

Available options:
h264,
av1
tokenTtlSeconds
integer
default:3600
Required range: 300 <= x <= 86400
allowedDomains
string[]

Optional playback domain allowlist.

Maximum array length: 25
captions
object[]
Maximum array length: 20

Response

Video stream accepted for processing

stream
object
Last modified on July 31, 2026