Stream

Lists the origins allowed to display the video. Enter allowed origin domains in an array and use * for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.

created?: string

The date and time the media item was created.

formatdate-time

creator?: string

A user-defined identifier for the media creator.

maxLength64

duration?: number

The duration of the video in seconds. A value of -1 means the duration is unknown. The duration becomes available after the upload and before the video is ready.

input?: Input { height, width }

height?: number

The video height in pixels. A value of -1 means the height is unknown. The value becomes available after the upload and before the video is ready.

width?: number

The video width in pixels. A value of -1 means the width is unknown. The value becomes available after the upload and before the video is ready.

liveInput?: string

The live input ID used to upload a video with Stream Live.

maxLength32

maxDurationSeconds?: number

The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of -1 means the value is unknown.

maximum36000

minimum1

meta?: unknown

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

modified?: string

The date and time the media item was last modified.

formatdate-time

playback?: Playback { dash, hls }

dash?: string

DASH Media Presentation Description for the video.

hls?: string

The HLS manifest for the video.

preview?: string

The video's preview page URI. This field is omitted until encoding is complete.

formaturi

readyToStream?: boolean

Indicates whether the video is playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.

readyToStreamAt?: string

Indicates the time at which the video became playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.

formatdate-time

requireSignedURLs?: boolean

Indicates whether the video can be a accessed using the UID. When set to true, a signed token must be generated with a signing key to view the video.

scheduledDeletion?: string

Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a null value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time.

formatdate-time

size?: number

The size of the media item in bytes.

status?: Status { errorReasonCode, errorReasonText, pctComplete, state }

Specifies a detailed status for a video. If the state is inprogress or error, the step field returns encoding or manifest. If the state is inprogress, pctComplete returns a number between 0 and 100 to indicate the approximate percent of completion. If the state is error, errorReasonCode and errorReasonText provide additional details.

errorReasonCode?: string

Specifies why the video failed to encode. This field is empty if the video is not in an error state. Preferred for programmatic use.

errorReasonText?: string

Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an error state.

pctComplete?: string

Indicates the progress as a percentage between 0 and 100.

maximum100

minimum0

state?: "pendingupload" | "downloading" | "queued" | 4 more

Specifies the processing status for all quality levels for a video.

One of the following:

"pendingupload"

"downloading"

"queued"

"inprogress"

"ready"

"error"

"live-inprogress"

thumbnail?: string

The media item's thumbnail URI. This field is omitted until encoding is complete.

formaturi

thumbnailTimestampPct?: number

The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video.

maximum1

minimum0

uid?: string

A Cloudflare-generated unique identifier for a media item.

maxLength32

uploaded?: string

The date and time the media item was uploaded.

formatdate-time

uploadExpiry?: string

The date and time when the video upload URL is no longer valid for direct user uploads.

formatdate-time

watermark?: Watermark { created, downloadedFrom, height, 8 more }

StreamAudio Tracks

List additional audio tracks on a video

client.stream.audioTracks.get(, , ?): SinglePage<Audio { default, label, status, uid } >

GET/accounts/{account_id}/stream/{identifier}/audio

Edit additional audio tracks on a video

client.stream.audioTracks.edit(, , , ?): Audio { default, label, status, uid }

PATCH/accounts/{account_id}/stream/{identifier}/audio/{audio_identifier}

Delete additional audio tracks on a video

client.stream.audioTracks.delete(, , , ?): AudioTrackDeleteResponse

DELETE/accounts/{account_id}/stream/{identifier}/audio/{audio_identifier}

Add audio tracks to a video

client.stream.audioTracks.copy(, , ?): Audio { default, label, status, uid }

POST/accounts/{account_id}/stream/{identifier}/audio/copy

ModelsExpand Collapse

Audio { default, label, status, uid }

default?: boolean

Denotes whether the audio track will be played by default in a player.

label?: string

A string to uniquely identify the track amongst other audio track labels for the specified video.

status?: "queued" | "ready" | "error"

Specifies the processing status of the video.

One of the following:

"queued"

"ready"

"error"

uid?: string

A Cloudflare-generated unique identifier for a media item.

maxLength32

AudioTrackDeleteResponse = string

StreamVideos

Storage use

client.stream.videos.storageUsage(, ?): VideoStorageUsageResponse { creator, totalStorageMinutes, totalStorageMinutesLimit, videoCount }

GET/accounts/{account_id}/stream/storage-usage

ModelsExpand Collapse

VideoStorageUsageResponse { creator, totalStorageMinutes, totalStorageMinutesLimit, videoCount }

creator?: string

A user-defined identifier for the media creator.

maxLength64

totalStorageMinutes?: number

The total minutes of video content stored in the account.

totalStorageMinutesLimit?: number

The storage capacity alloted for the account.

videoCount?: number

The total count of videos associated with the account.

StreamClip

Clip videos given a start and end time

client.stream.clip.create(, ?): Clip { allowedOrigins, clippedFromVideoUID, created, 12 more }

POST/accounts/{account_id}/stream/clip

ModelsExpand Collapse

Clip { allowedOrigins, clippedFromVideoUID, created, 12 more }

allowedOrigins?: Array<AllowedOrigins>

Lists the origins allowed to display the video. Enter allowed origin domains in an array and use * for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.

clippedFromVideoUID?: string

The unique video identifier (UID).

maxLength32

created?: string

The date and time the clip was created.

formatdate-time

creator?: string

A user-defined identifier for the media creator.

maxLength64

endTimeSeconds?: number

Specifies the end time for the video clip in seconds.

maxDurationSeconds?: number

The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of -1 means the value is unknown.

maximum36000

minimum1

meta?: unknown

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

modified?: string

The date and time the live input was last modified.

formatdate-time

playback?: Playback { dash, hls }

dash?: string

DASH Media Presentation Description for the video.

hls?: string

The HLS manifest for the video.

preview?: string

The video's preview page URI. This field is omitted until encoding is complete.

formaturi

requireSignedURLs?: boolean

Indicates whether the video can be a accessed using the UID. When set to true, a signed token must be generated with a signing key to view the video.

startTimeSeconds?: number

Specifies the start time for the video clip in seconds.

status?: "pendingupload" | "downloading" | "queued" | 4 more

Specifies the processing status for all quality levels for a video.

One of the following:

"pendingupload"

"downloading"

"queued"

"inprogress"

"ready"

"error"

"live-inprogress"

thumbnailTimestampPct?: number

The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video.

maximum1

minimum0

watermark?: Watermark { uid }

uid?: string

The unique identifier for the watermark profile.

maxLength32

StreamCopy

Upload videos from a URL

client.stream.copy.create(, ?): Video { allowedOrigins, created, creator, 20 more }

POST/accounts/{account_id}/stream/copy

StreamDirect Upload

Upload videos via direct upload URLs

client.stream.directUpload.create(, ?): DirectUploadCreateResponse { scheduledDeletion, uid, uploadURL, watermark }

POST/accounts/{account_id}/stream/direct_upload

ModelsExpand Collapse

DirectUploadCreateResponse { scheduledDeletion, uid, uploadURL, watermark }

scheduledDeletion?: string

Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a null value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time.

formatdate-time

uid?: string

A Cloudflare-generated unique identifier for a media item.

maxLength32

uploadURL?: string

The URL an unauthenticated upload can use for a single HTTP POST multipart/form-data request.

watermark?: Watermark { created, downloadedFrom, height, 8 more }

StreamKeys

List signing keys

client.stream.keys.get(, ?): SinglePage<KeyGetResponse { id, created } >

GET/accounts/{account_id}/stream/keys

Create signing keys

client.stream.keys.create(, ?): Keys { id, created, jwk, pem }

POST/accounts/{account_id}/stream/keys

Delete signing keys

client.stream.keys.delete(, , ?): KeyDeleteResponse

DELETE/accounts/{account_id}/stream/keys/{identifier}

ModelsExpand Collapse

Keys { id, created, jwk, pem }

id?: string

Identifier.

maxLength32

created?: string

The date and time a signing key was created.

formatdate-time

jwk?: string

The signing key in JWK format.

pem?: string

The signing key in PEM format.

KeyGetResponse { id, created }

id?: string

Identifier.

maxLength32

created?: string

The date and time a signing key was created.

formatdate-time

KeyDeleteResponse = string

StreamLive Inputs

List live inputs

client.stream.liveInputs.list(, ?): LiveInputListResponse { liveInputs, range, total }

GET/accounts/{account_id}/stream/live_inputs

Retrieve a live input

client.stream.liveInputs.get(, , ?): LiveInput { created, deleteRecordingAfterDays, enabled, 11 more }

GET/accounts/{account_id}/stream/live_inputs/{live_input_identifier}

Create a live input

client.stream.liveInputs.create(, ?): LiveInput { created, deleteRecordingAfterDays, enabled, 11 more }

POST/accounts/{account_id}/stream/live_inputs

Update a live input

client.stream.liveInputs.update(, , ?): LiveInput { created, deleteRecordingAfterDays, enabled, 11 more }

PUT/accounts/{account_id}/stream/live_inputs/{live_input_identifier}

Delete a live input

client.stream.liveInputs.delete(, , ?): void

DELETE/accounts/{account_id}/stream/live_inputs/{live_input_identifier}

ModelsExpand Collapse

LiveInput { created, deleteRecordingAfterDays, enabled, 11 more }

Details about a live input.

created?: string

The date and time the live input was created.

formatdate-time

deleteRecordingAfterDays?: number

Indicates the number of days after which the live inputs recordings will be deleted. When a stream completes and the recording is ready, the value is used to calculate a scheduled deletion date for that recording. Omit the field to indicate no change, or include with a null value to remove an existing scheduled deletion.

minimum30

enabled?: boolean

Indicates whether the live input is enabled and can accept streams.

meta?: unknown

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

modified?: string

The date and time the live input was last modified.

formatdate-time

recording?: Recording { allowedOrigins, hideLiveViewerCount, mode, 2 more }

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.

allowedOrigins?: Array<string>

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.

hideLiveViewerCount?: boolean

Disables reporting the number of live viewers when this property is set to true.

mode?: "off" | "automatic"

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.

One of the following:

"off"

"automatic"

requireSignedURLs?: boolean

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.

timeoutSeconds?: number

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.

rtmps?: Rtmps { streamKey, url }

Details for streaming to an live input using RTMPS.

streamKey?: string

The secret key to use when streaming via RTMPS to a live input.

url?: string

The RTMPS URL you provide to the broadcaster, which they stream live video to.

rtmpsPlayback?: RtmpsPlayback { streamKey, url }

Details for playback from an live input using RTMPS.

streamKey?: string

The secret key to use for playback via RTMPS.

url?: string

The URL used to play live video over RTMPS.

srt?: Srt { passphrase, streamId, url }

Details for streaming to a live input using SRT.

passphrase?: string

The secret key to use when streaming via SRT to a live input.

streamId?: string

The identifier of the live input to use when streaming via SRT.

url?: string

The SRT URL you provide to the broadcaster, which they stream live video to.

srtPlayback?: SrtPlayback { passphrase, streamId, url }

Details for playback from an live input using SRT.

passphrase?: string

The secret key to use for playback via SRT.

streamId?: string

The identifier of the live input to use for playback via SRT.

url?: string

The URL used to play live video over SRT.

status?: "connected" | "reconnected" | "reconnecting" | 5 more | null

The connection status of a live input.

One of the following:

"connected"

"reconnected"

"reconnecting"

"client_disconnect"

"ttl_exceeded"

"failed_to_connect"

"failed_to_reconnect"

"new_configuration_accepted"

uid?: string

A unique identifier for a live input.

maxLength32

webRTC?: WebRtc { url }

Details for streaming to a live input using WebRTC.

url?: string

The WebRTC URL you provide to the broadcaster, which they stream live video to.

webRTCPlayback?: WebRtcPlayback { url }

Details for playback from a live input using WebRTC.

url?: string

The URL used to play live video over WebRTC.

LiveInputListResponse { liveInputs, range, total }

liveInputs?: Array<LiveInput>

created?: string

The date and time the live input was created.

formatdate-time

deleteRecordingAfterDays?: number

Indicates the number of days after which the live inputs recordings will be deleted. When a stream completes and the recording is ready, the value is used to calculate a scheduled deletion date for that recording. Omit the field to indicate no change, or include with a null value to remove an existing scheduled deletion.

minimum30

enabled?: boolean

Indicates whether the live input is enabled and can accept streams.

meta?: unknown

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

modified?: string

The date and time the live input was last modified.

formatdate-time

uid?: string

A unique identifier for a live input.

maxLength32

range?: number

The total number of remaining live inputs based on cursor position.

total?: number

The total number of live inputs that match the provided filters.

StreamLive InputsOutputs

List all outputs associated with a specified live input

client.stream.liveInputs.outputs.list(, , ?): SinglePage<Output { enabled, streamKey, uid, url } >

GET/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs

Create a new output, connected to a live input

client.stream.liveInputs.outputs.create(, , ?): Output { enabled, streamKey, uid, url }

POST/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs

Update an output

client.stream.liveInputs.outputs.update(, , , ?): Output { enabled, streamKey, uid, url }

PUT/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}

Delete an output

client.stream.liveInputs.outputs.delete(, , , ?): void

DELETE/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}

ModelsExpand Collapse

Output { enabled, streamKey, uid, url }

enabled?: boolean

When enabled, live video streamed to the associated live input will be sent to the output URL. When disabled, live video will not be sent to the output URL, even when streaming to the associated live input. Use this to control precisely when you start and stop simulcasting to specific destinations like YouTube and Twitch.

streamKey?: string

The streamKey used to authenticate against an output's target.

uid?: string

A unique identifier for the output.

maxLength32

url?: string

The URL an output uses to restream.

StreamWatermarks

List watermark profiles

client.stream.watermarks.list(, ?): SinglePage<Watermark { created, downloadedFrom, height, 8 more } >

GET/accounts/{account_id}/stream/watermarks

Watermark profile details

client.stream.watermarks.get(, , ?): Watermark { created, downloadedFrom, height, 8 more }

GET/accounts/{account_id}/stream/watermarks/{identifier}

Create watermark profiles via basic upload

client.stream.watermarks.create(, ?): Watermark { created, downloadedFrom, height, 8 more }

POST/accounts/{account_id}/stream/watermarks

Delete watermark profiles

client.stream.watermarks.delete(, , ?): WatermarkDeleteResponse

DELETE/accounts/{account_id}/stream/watermarks/{identifier}

ModelsExpand Collapse

Watermark { created, downloadedFrom, height, 8 more }

created?: string

The date and a time a watermark profile was created.

formatdate-time

downloadedFrom?: string

The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.

height?: number

The height of the image in pixels.

name?: string

A short description of the watermark profile.

opacity?: number

The translucency of the image. A value of 0.0 makes the image completely transparent, and 1.0 makes the image completely opaque. Note that if the image is already semi-transparent, setting this to 1.0 will not make the image completely opaque.

maximum1

minimum0

padding?: number

The whitespace between the adjacent edges (determined by position) of the video and the image. 0.0 indicates no padding, and 1.0 indicates a fully padded video width or length, as determined by the algorithm.

maximum1

minimum0

position?: string

The location of the image. Valid positions are: upperRight, upperLeft, lowerLeft, lowerRight, and center. Note that center ignores the padding parameter.

scale?: number

The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. 0.0 indicates no scaling (use the size of the image as-is), and 1.0 fills the entire video.

maximum1

minimum0

size?: number

The size of the image in bytes.

uid?: string

The unique identifier for a watermark profile.

maxLength32

width?: number

The width of the image in pixels.

WatermarkDeleteResponse = string

ModelsExpand Collapse

WebhookGetResponse = unknown

WebhookUpdateResponse = unknown

WebhookDeleteResponse = string

StreamCaptions

List captions or subtitles

client.stream.captions.get(, , ?): SinglePage<Caption { generated, label, language, status } >

GET/accounts/{account_id}/stream/{identifier}/captions

ModelsExpand Collapse

Caption { generated, label, language, status }

generated?: boolean

Whether the caption was generated via AI.

label?: string

The language label displayed in the native language to users.

language?: string

The language tag in BCP 47 format.

status?: "ready" | "inprogress" | "error"

The status of a generated caption.

One of the following:

"ready"

"inprogress"

"error"

ModelsExpand Collapse

LanguageDeleteResponse = string

StreamCaptionsLanguageVtt

Return WebVTT captions for a provided language

client.stream.captions.language.vtt.get(, , , ?): VttGetResponse

GET/accounts/{account_id}/stream/{identifier}/captions/{language}/vtt

ModelsExpand Collapse

VttGetResponse = string

ModelsExpand Collapse

DownloadGetResponse { audio, default }

An object with download type keys. Each key is optional and only present if that download type has been created.

audio?: Audio { percentComplete, status, url }

The audio-only download. Only present if this download type has been created.

percentComplete?: number

Indicates the progress as a percentage between 0 and 100.

maximum100

minimum0

status?: "ready" | "inprogress" | "error"

The status of a generated download.

One of the following:

"ready"

"inprogress"

"error"

url?: string

The URL to access the generated download.

formaturi

default?: Default { percentComplete, status, url }

The default video download. Only present if this download type has been created.

percentComplete?: number

Indicates the progress as a percentage between 0 and 100.

maximum100

minimum0

status?: "ready" | "inprogress" | "error"

The status of a generated download.

One of the following:

"ready"

"inprogress"

"error"

url?: string

The URL to access the generated download.

formaturi

DownloadCreateResponse { percentComplete, status, url }

percentComplete?: number

Indicates the progress as a percentage between 0 and 100.

maximum100

minimum0

status?: "ready" | "inprogress" | "error"

The status of a generated download.

One of the following:

"ready"

"inprogress"

"error"

url?: string

The URL to access the generated download.

formaturi

DownloadDeleteResponse = string

StreamEmbed

Retrieve embed Code HTML

client.stream.embed.get(, , ?): EmbedGetResponse

GET/accounts/{account_id}/stream/{identifier}/embed

ModelsExpand Collapse

EmbedGetResponse = string

StreamToken

Create signed URL tokens for videos

client.stream.token.create(, , ?): TokenCreateResponse { token }

POST/accounts/{account_id}/stream/{identifier}/token

ModelsExpand Collapse

TokenCreateResponse { token }

token?: string

The signed token used with the signed URLs feature.

Stream

ModelsExpand Collapse

StreamAudio Tracks

ModelsExpand Collapse

StreamVideos

ModelsExpand Collapse

StreamClip

ModelsExpand Collapse

StreamCopy

StreamDirect Upload

ModelsExpand Collapse

StreamKeys

ModelsExpand Collapse

StreamLive Inputs

ModelsExpand Collapse

StreamLive InputsOutputs

ModelsExpand Collapse

StreamWatermarks

ModelsExpand Collapse

StreamWebhooks

ModelsExpand Collapse

StreamCaptions

ModelsExpand Collapse

StreamCaptionsLanguage

ModelsExpand Collapse

StreamCaptionsLanguageVtt

ModelsExpand Collapse

StreamDownloads

ModelsExpand Collapse

StreamEmbed

ModelsExpand Collapse

StreamToken

ModelsExpand Collapse