--- title: Stream --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Stream ##### [List videos](https://developers.cloudflare.com/api/python/resources/stream/methods/list) stream.list(StreamListParams\*\*kwargs) -> SyncSinglePage\[[Video]()] GET/accounts/{account\_id}/stream ##### [Retrieve video details](https://developers.cloudflare.com/api/python/resources/stream/methods/get) stream.get(stridentifier, StreamGetParams\*\*kwargs) -> [Video]() GET/accounts/{account\_id}/stream/{identifier} ##### [Initiate video uploads using TUS](https://developers.cloudflare.com/api/python/resources/stream/methods/create) stream.create(StreamCreateParams\*\*kwargs) POST/accounts/{account\_id}/stream ##### [Edit video details](https://developers.cloudflare.com/api/python/resources/stream/methods/edit) stream.edit(stridentifier, StreamEditParams\*\*kwargs) -> [Video]() POST/accounts/{account\_id}/stream/{identifier} ##### [Delete video](https://developers.cloudflare.com/api/python/resources/stream/methods/delete) stream.delete(stridentifier, StreamDeleteParams\*\*kwargs) DELETE/accounts/{account\_id}/stream/{identifier} ##### ModelsExpand Collapse str [Link to this property](<#(resource)%20stream%20%3E%20(model)%20allowed_origins%20%3E%20(schema)>)
class Video: … allowed\_origins: Optional\[List\[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. Link to this property clipped\_from: Optional\[str] The unique identifier of the source video this video was clipped from. Link to this property created: Optional\[datetime] The date and time the media item was created. formatdate-time Link to this property creator: Optional\[str] A user-defined identifier for the media creator. maxLength64 Link to this property duration: Optional\[float] 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. Link to this property
input: Optional\[Input] height: Optional\[int] 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. Link to this property width: Optional\[int] 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. Link to this property
Link to this property live\_input: Optional\[str] The live input ID used to upload a video with Stream Live. maxLength32 Link to this property max\_duration\_seconds: Optional\[int] 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 Link to this property max\_size\_bytes: Optional\[int] The maximum size in bytes for the video upload. formatint64 Link to this property meta: Optional\[object] A user modifiable key-value store used to reference other systems of record for managing videos. Link to this property modified: Optional\[datetime] The date and time the media item was last modified. formatdate-time Link to this property
playback: Optional\[Playback] dash: Optional\[str] DASH Media Presentation Description for the video. Link to this property hls: Optional\[str] The HLS manifest for the video. Link to this property
Link to this property preview: Optional\[str] The video’s preview page URI. This field is omitted until encoding is complete. formaturi Link to this property
public\_details: Optional\[PublicDetails] Public details for the video including title, share link, channel link, and logo. channel\_link: Optional\[str] Link to this property logo: Optional\[str] Link to this property media\_id: Optional\[int] Link to this property share\_link: Optional\[str] Link to this property title: Optional\[str] Link to this property
Link to this property ready\_to\_stream: Optional\[bool] 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. Link to this property ready\_to\_stream\_at: Optional\[datetime] 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 Link to this property require\_signed\_urls: Optional\[bool] 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. Link to this property scheduled\_deletion: Optional\[datetime] 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 Link to this property size: Optional\[float] The size of the media item in bytes. Link to this property
status: Optional\[Status] 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. error\_reason\_code: Optional\[str] Specifies why the video failed to encode. This field is empty if the video is not in an error state. Preferred for programmatic use. Link to this property error\_reason\_text: Optional\[str] 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. Link to this property pct\_complete: Optional\[str] Indicates the progress as a percentage between 0 and 100. Link to this property
state: Optional\[Literal\["pendingupload", "downloading", "queued", 4 more]] Specifies the processing status for all quality levels for a video. One of the following: "pendingupload" Link to this property "downloading" Link to this property "queued" Link to this property "inprogress" Link to this property "ready" Link to this property "error" Link to this property "live-inprogress" Link to this property
Link to this property
Link to this property thumbnail: Optional\[str] The media item’s thumbnail URI. This field is omitted until encoding is complete. formaturi Link to this property thumbnail\_timestamp\_pct: Optional\[float] 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 Link to this property uid: Optional\[str] A Cloudflare-generated unique identifier for a media item. maxLength32 Link to this property uploaded: Optional\[datetime] The date and time the media item was uploaded. formatdate-time Link to this property upload\_expiry: Optional\[datetime] The date and time when the video upload URL is no longer valid for direct user uploads. formatdate-time Link to this property watermark: Optional\[Watermark] Link to this property
[Link to this property](<#(resource)%20stream%20%3E%20(model)%20video%20%3E%20(schema)>) #### StreamAudio Tracks ##### [List additional audio tracks on a video](https://developers.cloudflare.com/api/python/resources/stream/subresources/audio_tracks/methods/get) stream.audio\_tracks.get(stridentifier, AudioTrackGetParams\*\*kwargs) -> [AudioTrackGetResponse]() GET/accounts/{account\_id}/stream/{identifier}/audio ##### [Edit additional audio tracks on a video](https://developers.cloudflare.com/api/python/resources/stream/subresources/audio_tracks/methods/edit) stream.audio\_tracks.edit(straudio\_identifier, AudioTrackEditParams\*\*kwargs) -> [Audio]() PATCH/accounts/{account\_id}/stream/{identifier}/audio/{audio\_identifier} ##### [Delete additional audio tracks on a video](https://developers.cloudflare.com/api/python/resources/stream/subresources/audio_tracks/methods/delete) stream.audio\_tracks.delete(straudio\_identifier, AudioTrackDeleteParams\*\*kwargs) -> [AudioTrackDeleteResponse]() DELETE/accounts/{account\_id}/stream/{identifier}/audio/{audio\_identifier} ##### [Add audio tracks to a video](https://developers.cloudflare.com/api/python/resources/stream/subresources/audio_tracks/methods/copy) stream.audio\_tracks.copy(stridentifier, AudioTrackCopyParams\*\*kwargs) -> [Audio]() POST/accounts/{account\_id}/stream/{identifier}/audio/copy ##### ModelsExpand Collapse
class Audio: … default: Optional\[bool] Denotes whether the audio track will be played by default in a player. Link to this property label: Optional\[str] A string to uniquely identify the track amongst other audio track labels for the specified video. Link to this property
status: Optional\[Literal\["queued", "ready", "error"]] Specifies the processing status of the video. One of the following: "queued" Link to this property "ready" Link to this property "error" Link to this property
Link to this property uid: Optional\[str] A Cloudflare-generated unique identifier for a media item. maxLength32 Link to this property
[Link to this property](<#(resource)%20stream.audio_tracks%20%3E%20(model)%20audio%20%3E%20(schema)>)
class AudioTrackGetResponse: …
audio: Optional\[List\[Audio]] Array of audio tracks for the video. default: Optional\[bool] Denotes whether the audio track will be played by default in a player. Link to this property label: Optional\[str] A string to uniquely identify the track amongst other audio track labels for the specified video. Link to this property
status: Optional\[Literal\["queued", "ready", "error"]] Specifies the processing status of the video. One of the following: "queued" Link to this property "ready" Link to this property "error" Link to this property
Link to this property uid: Optional\[str] A Cloudflare-generated unique identifier for a media item. maxLength32 Link to this property
Link to this property
[Link to this property](<#(resource)%20stream.audio_tracks%20%3E%20(model)%20audio_track_get_response%20%3E%20(schema)>) str [Link to this property](<#(resource)%20stream.audio_tracks%20%3E%20(model)%20audio_track_delete_response%20%3E%20(schema)>) #### StreamVideos ##### [Storage use](https://developers.cloudflare.com/api/python/resources/stream/subresources/videos/methods/storage_usage) stream.videos.storage\_usage(VideoStorageUsageParams\*\*kwargs) -> [VideoStorageUsageResponse]() GET/accounts/{account\_id}/stream/storage-usage ##### ModelsExpand Collapse
class VideoStorageUsageResponse: … creator: Optional\[str] A user-defined identifier for the media creator. maxLength64 Link to this property total\_storage\_minutes: Optional\[float] The total minutes of video content stored in the account. May contain decimal values. formatfloat Link to this property total\_storage\_minutes\_limit: Optional\[int] The storage capacity alloted for the account. Link to this property video\_count: Optional\[int] The total count of videos associated with the account. Link to this property
[Link to this property](<#(resource)%20stream.videos%20%3E%20(model)%20video_storage_usage_response%20%3E%20(schema)>) #### StreamClip ##### [Clip videos given a start and end time](https://developers.cloudflare.com/api/python/resources/stream/subresources/clip/methods/create) stream.clip.create(ClipCreateParams\*\*kwargs) -> [Video]() POST/accounts/{account\_id}/stream/clip #### StreamCopy ##### [Upload videos from a URL](https://developers.cloudflare.com/api/python/resources/stream/subresources/copy/methods/create) stream.copy.create(CopyCreateParams\*\*kwargs) -> [Video]() POST/accounts/{account\_id}/stream/copy #### StreamDirect Upload ##### [Upload videos via direct upload URLs](https://developers.cloudflare.com/api/python/resources/stream/subresources/direct_upload/methods/create) stream.direct\_upload.create(DirectUploadCreateParams\*\*kwargs) -> [DirectUploadCreateResponse]() POST/accounts/{account\_id}/stream/direct\_upload ##### ModelsExpand Collapse
class DirectUploadCreateResponse: … scheduled\_deletion: Optional\[datetime] 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 Link to this property uid: Optional\[str] A Cloudflare-generated unique identifier for a media item. maxLength32 Link to this property upload\_url: Optional\[str] The URL an unauthenticated upload can use for a single HTTP POST multipart/form-data request. Link to this property watermark: Optional\[Watermark] Link to this property
[Link to this property](<#(resource)%20stream.direct_upload%20%3E%20(model)%20direct_upload_create_response%20%3E%20(schema)>) #### StreamKeys ##### [List signing keys](https://developers.cloudflare.com/api/python/resources/stream/subresources/keys/methods/get) stream.keys.get(KeyGetParams\*\*kwargs) -> SyncSinglePage\[[KeyGetResponse]()] GET/accounts/{account\_id}/stream/keys ##### [Create signing keys](https://developers.cloudflare.com/api/python/resources/stream/subresources/keys/methods/create) stream.keys.create(KeyCreateParams\*\*kwargs) -> [Keys]() POST/accounts/{account\_id}/stream/keys ##### [Delete signing keys](https://developers.cloudflare.com/api/python/resources/stream/subresources/keys/methods/delete) stream.keys.delete(stridentifier, KeyDeleteParams\*\*kwargs) -> [KeyDeleteResponse]() DELETE/accounts/{account\_id}/stream/keys/{identifier} ##### ModelsExpand Collapse
class Keys: … id: Optional\[str] Identifier. maxLength32 Link to this property created: Optional\[datetime] The date and time a signing key was created. formatdate-time Link to this property jwk: Optional\[str] The signing key in JWK format. Link to this property pem: Optional\[str] The signing key in PEM format. Link to this property
[Link to this property](<#(resource)%20stream.keys%20%3E%20(model)%20keys%20%3E%20(schema)>)
class KeyGetResponse: … id: Optional\[str] Identifier. maxLength32 Link to this property created: Optional\[datetime] The date and time a signing key was created. formatdate-time Link to this property key\_id: Optional\[str] The unique identifier for the signing key. Link to this property
[Link to this property](<#(resource)%20stream.keys%20%3E%20(model)%20key_get_response%20%3E%20(schema)>) str [Link to this property](<#(resource)%20stream.keys%20%3E%20(model)%20key_delete_response%20%3E%20(schema)>) #### StreamLive Inputs ##### [List live inputs](https://developers.cloudflare.com/api/python/resources/stream/subresources/live_inputs/methods/list) stream.live\_inputs.list(LiveInputListParams\*\*kwargs) -> [LiveInputListResponse]() GET/accounts/{account\_id}/stream/live\_inputs ##### [Retrieve a live input](https://developers.cloudflare.com/api/python/resources/stream/subresources/live_inputs/methods/get) stream.live\_inputs.get(strlive\_input\_identifier, LiveInputGetParams\*\*kwargs) -> [LiveInput]() GET/accounts/{account\_id}/stream/live\_inputs/{live\_input\_identifier} ##### [Create a live input](https://developers.cloudflare.com/api/python/resources/stream/subresources/live_inputs/methods/create) stream.live\_inputs.create(LiveInputCreateParams\*\*kwargs) -> [LiveInput]() POST/accounts/{account\_id}/stream/live\_inputs ##### [Update a live input](https://developers.cloudflare.com/api/python/resources/stream/subresources/live_inputs/methods/update) stream.live\_inputs.update(strlive\_input\_identifier, LiveInputUpdateParams\*\*kwargs) -> [LiveInput]() PUT/accounts/{account\_id}/stream/live\_inputs/{live\_input\_identifier} ##### [Delete a live input](https://developers.cloudflare.com/api/python/resources/stream/subresources/live_inputs/methods/delete) stream.live\_inputs.delete(strlive\_input\_identifier, LiveInputDeleteParams\*\*kwargs) DELETE/accounts/{account\_id}/stream/live\_inputs/{live\_input\_identifier} ##### ModelsExpand Collapse
class LiveInput: … Details about a live input. created: Optional\[datetime] The date and time the live input was created. formatdate-time Link to this property delete\_recording\_after\_days: Optional\[float] 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 Link to this property enabled: Optional\[bool] Indicates whether the live input is enabled and can accept streams. Link to this property keys\_rotated\_at: Optional\[datetime] The date and time the live input keys were last rotated. Omitted for live inputs that have never had their keys rotated. formatdate-time Link to this property meta: Optional\[object] A user modifiable key-value store used to reference other systems of record for managing live inputs. Link to this property modified: Optional\[datetime] The date and time the live input was last modified. formatdate-time Link to this property
playback: Optional\[Playback] Details for playing a live input’s broadcast using the HLS or DASH manifests. URLs reference the live input ID. dash: str The DASH manifest URL used to play live video, referencing the live input ID. Link to this property hls: str The HLS manifest URL used to play live video, referencing the live input ID. Link to this property
Link to this property prefer\_low\_latency: Optional\[bool] When enabled, the live stream is delivered using Low-Latency HLS (LL-HLS), reducing glass-to-glass latency for viewers at the cost of reduced player compatibility. Link to this property
recording: Optional\[Recording] 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. allowed\_origins: Optional\[List\[str]] 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. Link to this property hide\_live\_viewer\_count: Optional\[bool] Disables reporting the number of live viewers when this property is set to true. Link to this property
mode: Optional\[Literal\["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" Link to this property "automatic" Link to this property
Link to this property require\_signed\_urls: Optional\[bool] 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. Link to this property timeout\_seconds: Optional\[int] 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. Link to this property
Link to this property
rtmps: Optional\[Rtmps] Details for streaming to an live input using RTMPS. stream\_key: Optional\[str] The secret key to use when streaming via RTMPS to a live input. Link to this property url: Optional\[str] The RTMPS URL you provide to the broadcaster, which they stream live video to. Link to this property
Link to this property
rtmps\_playback: Optional\[RtmpsPlayback] Details for playback from an live input using RTMPS. stream\_key: Optional\[str] The secret key to use for playback via RTMPS. Link to this property url: Optional\[str] The URL used to play live video over RTMPS. Link to this property
Link to this property
srt: Optional\[Srt] Details for streaming to a live input using SRT. passphrase: Optional\[str] The secret key to use when streaming via SRT to a live input. Link to this property stream\_id: Optional\[str] The identifier of the live input to use when streaming via SRT. Link to this property url: Optional\[str] The SRT URL you provide to the broadcaster, which they stream live video to. Link to this property
Link to this property
srt\_playback: Optional\[SrtPlayback] Details for playback from an live input using SRT. passphrase: Optional\[str] The secret key to use for playback via SRT. Link to this property stream\_id: Optional\[str] The identifier of the live input to use for playback via SRT. Link to this property url: Optional\[str] The URL used to play live video over SRT. Link to this property
Link to this property
status: Optional\[Literal\["connected", "reconnected", "reconnecting", 5 more]] The connection status of a live input. One of the following: "connected" Link to this property "reconnected" Link to this property "reconnecting" Link to this property "client\_disconnect" Link to this property "ttl\_exceeded" Link to this property "failed\_to\_connect" Link to this property "failed\_to\_reconnect" Link to this property "new\_configuration\_accepted" Link to this property
Link to this property uid: Optional\[str] A unique identifier for a live input. maxLength32 Link to this property
web\_rtc: Optional\[WebRtc] Details for streaming to a live input using WebRTC. url: Optional\[str] The WebRTC URL you provide to the broadcaster, which they stream live video to. Link to this property
Link to this property
web\_rtc\_playback: Optional\[WebRtcPlayback] Details for playback from a live input using WebRTC. url: Optional\[str] The URL used to play live video over WebRTC. Link to this property
Link to this property
[Link to this property](<#(resource)%20stream.live_inputs%20%3E%20(model)%20live_input%20%3E%20(schema)>)
class LiveInputListResponse: …
live\_inputs: Optional\[List\[LiveInput]] created: Optional\[datetime] The date and time the live input was created. formatdate-time Link to this property delete\_recording\_after\_days: Optional\[float] 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 Link to this property enabled: Optional\[bool] Indicates whether the live input is enabled and can accept streams. Link to this property meta: Optional\[object] A user modifiable key-value store used to reference other systems of record for managing live inputs. Link to this property modified: Optional\[datetime] The date and time the live input was last modified. formatdate-time Link to this property uid: Optional\[str] A unique identifier for a live input. maxLength32 Link to this property
Link to this property range: Optional\[int] The total number of remaining live inputs based on cursor position. Link to this property total: Optional\[int] The total number of live inputs that match the provided filters. Link to this property
[Link to this property](<#(resource)%20stream.live_inputs%20%3E%20(model)%20live_input_list_response%20%3E%20(schema)>) #### StreamLive InputsOutputs ##### [List all outputs associated with a specified live input](https://developers.cloudflare.com/api/python/resources/stream/subresources/live_inputs/subresources/outputs/methods/list) stream.live\_inputs.outputs.list(strlive\_input\_identifier, OutputListParams\*\*kwargs) -> SyncSinglePage\[[Output]()] GET/accounts/{account\_id}/stream/live\_inputs/{live\_input\_identifier}/outputs ##### [Create a new output, connected to a live input](https://developers.cloudflare.com/api/python/resources/stream/subresources/live_inputs/subresources/outputs/methods/create) stream.live\_inputs.outputs.create(strlive\_input\_identifier, OutputCreateParams\*\*kwargs) -> [Output]() POST/accounts/{account\_id}/stream/live\_inputs/{live\_input\_identifier}/outputs ##### [Update an output](https://developers.cloudflare.com/api/python/resources/stream/subresources/live_inputs/subresources/outputs/methods/update) stream.live\_inputs.outputs.update(stroutput\_identifier, OutputUpdateParams\*\*kwargs) -> [Output]() PUT/accounts/{account\_id}/stream/live\_inputs/{live\_input\_identifier}/outputs/{output\_identifier} ##### [Delete an output](https://developers.cloudflare.com/api/python/resources/stream/subresources/live_inputs/subresources/outputs/methods/delete) stream.live\_inputs.outputs.delete(stroutput\_identifier, OutputDeleteParams\*\*kwargs) DELETE/accounts/{account\_id}/stream/live\_inputs/{live\_input\_identifier}/outputs/{output\_identifier} ##### ModelsExpand Collapse
class Output: … enabled: Optional\[bool] 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. Link to this property stream\_key: Optional\[str] The streamKey used to authenticate against an output’s target. Link to this property uid: Optional\[str] A unique identifier for the output. maxLength32 Link to this property url: Optional\[str] The URL an output uses to restream. Link to this property
[Link to this property](<#(resource)%20stream.live_inputs.outputs%20%3E%20(model)%20output%20%3E%20(schema)>) #### StreamWatermarks ##### [List watermark profiles](https://developers.cloudflare.com/api/python/resources/stream/subresources/watermarks/methods/list) stream.watermarks.list(WatermarkListParams\*\*kwargs) -> SyncSinglePage\[[Watermark]()] GET/accounts/{account\_id}/stream/watermarks ##### [Watermark profile details](https://developers.cloudflare.com/api/python/resources/stream/subresources/watermarks/methods/get) stream.watermarks.get(stridentifier, WatermarkGetParams\*\*kwargs) -> [Watermark]() GET/accounts/{account\_id}/stream/watermarks/{identifier} ##### [Create watermark profiles via basic upload](https://developers.cloudflare.com/api/python/resources/stream/subresources/watermarks/methods/create) stream.watermarks.create(WatermarkCreateParams\*\*kwargs) -> [Watermark]() POST/accounts/{account\_id}/stream/watermarks ##### [Delete watermark profiles](https://developers.cloudflare.com/api/python/resources/stream/subresources/watermarks/methods/delete) stream.watermarks.delete(stridentifier, WatermarkDeleteParams\*\*kwargs) -> [WatermarkDeleteResponse]() DELETE/accounts/{account\_id}/stream/watermarks/{identifier} ##### ModelsExpand Collapse
class Watermark: … created: Optional\[datetime] The date and a time a watermark profile was created. formatdate-time Link to this property downloaded\_from: Optional\[str] The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null. Link to this property height: Optional\[int] The height of the image in pixels. Link to this property name: Optional\[str] A short description of the watermark profile. Link to this property opacity: Optional\[float] 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 Link to this property padding: Optional\[float] 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 Link to this property position: Optional\[str] The location of the image. Valid positions are: upperRight, upperLeft, lowerLeft, lowerRight, and center. Note that center ignores the padding parameter. Link to this property scale: Optional\[float] 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 Link to this property size: Optional\[float] The size of the image in bytes. Link to this property uid: Optional\[str] The unique identifier for a watermark profile. maxLength32 Link to this property width: Optional\[int] The width of the image in pixels. Link to this property
[Link to this property](<#(resource)%20stream.watermarks%20%3E%20(model)%20watermark%20%3E%20(schema)>) str [Link to this property](<#(resource)%20stream.watermarks%20%3E%20(model)%20watermark_delete_response%20%3E%20(schema)>) #### StreamWebhooks ##### [View webhook](https://developers.cloudflare.com/api/python/resources/stream/subresources/webhooks/methods/get) stream.webhooks.get(WebhookGetParams\*\*kwargs) -> [WebhookGetResponse]() GET/accounts/{account\_id}/stream/webhook ##### [Create VOD webhooks](https://developers.cloudflare.com/api/python/resources/stream/subresources/webhooks/methods/update) stream.webhooks.update(WebhookUpdateParams\*\*kwargs) -> [WebhookUpdateResponse]() PUT/accounts/{account\_id}/stream/webhook ##### [Delete webhooks](https://developers.cloudflare.com/api/python/resources/stream/subresources/webhooks/methods/delete) stream.webhooks.delete(WebhookDeleteParams\*\*kwargs) -> [WebhookDeleteResponse]() DELETE/accounts/{account\_id}/stream/webhook ##### ModelsExpand Collapse
class WebhookGetResponse: … modified: Optional\[datetime] The date and time the webhook was last modified. formatdate-time Link to this property notification\_url: Optional\[str] The URL where webhooks will be sent. formaturi Link to this property secret: Optional\[str] The secret used to verify webhook signatures. Link to this property
[Link to this property](<#(resource)%20stream.webhooks%20%3E%20(model)%20webhook_get_response%20%3E%20(schema)>)
class WebhookUpdateResponse: … modified: Optional\[datetime] The date and time the webhook was last modified. formatdate-time Link to this property notification\_url: Optional\[str] The URL where webhooks will be sent. formaturi Link to this property secret: Optional\[str] The secret used to verify webhook signatures. Link to this property
[Link to this property](<#(resource)%20stream.webhooks%20%3E%20(model)%20webhook_update_response%20%3E%20(schema)>) str [Link to this property](<#(resource)%20stream.webhooks%20%3E%20(model)%20webhook_delete_response%20%3E%20(schema)>) #### StreamCaptions ##### [List captions or subtitles](https://developers.cloudflare.com/api/python/resources/stream/subresources/captions/methods/get) stream.captions.get(stridentifier, CaptionGetParams\*\*kwargs) -> SyncSinglePage\[[Caption]()] GET/accounts/{account\_id}/stream/{identifier}/captions ##### ModelsExpand Collapse
class Caption: … generated: Optional\[bool] Whether the caption was generated via AI. Link to this property label: Optional\[str] The language label displayed in the native language to users. Link to this property language: Optional\[str] The language tag in BCP 47 format. Link to this property
status: Optional\[Literal\["ready", "inprogress", "error"]] The status of a generated caption. One of the following: "ready" Link to this property "inprogress" Link to this property "error" Link to this property
Link to this property
[Link to this property](<#(resource)%20stream.captions%20%3E%20(model)%20caption%20%3E%20(schema)>) #### StreamCaptionsLanguage ##### [List captions or subtitles for a provided language](https://developers.cloudflare.com/api/python/resources/stream/subresources/captions/subresources/language/methods/get) stream.captions.language.get(strlanguage, LanguageGetParams\*\*kwargs) -> [Caption]() GET/accounts/{account\_id}/stream/{identifier}/captions/{language} ##### [Generate captions or subtitles for a provided language via AI](https://developers.cloudflare.com/api/python/resources/stream/subresources/captions/subresources/language/methods/create) stream.captions.language.create(strlanguage, LanguageCreateParams\*\*kwargs) -> [Caption]() POST/accounts/{account\_id}/stream/{identifier}/captions/{language}/generate ##### [Upload captions or subtitles](https://developers.cloudflare.com/api/python/resources/stream/subresources/captions/subresources/language/methods/update) stream.captions.language.update(strlanguage, LanguageUpdateParams\*\*kwargs) -> [Caption]() PUT/accounts/{account\_id}/stream/{identifier}/captions/{language} ##### [Delete captions or subtitles](https://developers.cloudflare.com/api/python/resources/stream/subresources/captions/subresources/language/methods/delete) stream.captions.language.delete(strlanguage, LanguageDeleteParams\*\*kwargs) -> [LanguageDeleteResponse]() DELETE/accounts/{account\_id}/stream/{identifier}/captions/{language} ##### ModelsExpand Collapse str [Link to this property](<#(resource)%20stream.captions.language%20%3E%20(model)%20language_delete_response%20%3E%20(schema)>) #### StreamCaptionsLanguageVtt ##### [Return WebVTT captions for a provided language](https://developers.cloudflare.com/api/python/resources/stream/subresources/captions/subresources/language/subresources/vtt/methods/get) stream.captions.language.vtt.get(strlanguage, VttGetParams\*\*kwargs) -> [VttGetResponse]() GET/accounts/{account\_id}/stream/{identifier}/captions/{language}/vtt ##### ModelsExpand Collapse str [Link to this property](<#(resource)%20stream.captions.language.vtt%20%3E%20(model)%20vtt_get_response%20%3E%20(schema)>) #### StreamDownloads ##### [List downloads](https://developers.cloudflare.com/api/python/resources/stream/subresources/downloads/methods/get) stream.downloads.get(stridentifier, DownloadGetParams\*\*kwargs) -> [DownloadGetResponse]() GET/accounts/{account\_id}/stream/{identifier}/downloads ##### [Create downloads](https://developers.cloudflare.com/api/python/resources/stream/subresources/downloads/methods/create) stream.downloads.create(stridentifier, DownloadCreateParams\*\*kwargs) -> [DownloadCreateResponse]() POST/accounts/{account\_id}/stream/{identifier}/downloads ##### [Delete downloads](https://developers.cloudflare.com/api/python/resources/stream/subresources/downloads/methods/delete) stream.downloads.delete(stridentifier, DownloadDeleteParams\*\*kwargs) -> [DownloadDeleteResponse]() DELETE/accounts/{account\_id}/stream/{identifier}/downloads ##### ModelsExpand Collapse
class DownloadGetResponse: … An object with download type keys. Each key is optional and only present if that download type has been created.
audio: Optional\[Audio] The audio-only download. Only present if this download type has been created. percent\_complete: float Indicates the progress as a percentage between 0 and 100. maximum100 minimum0 Link to this property
status: Literal\["ready", "inprogress", "error"] The status of a generated download. One of the following: "ready" Link to this property "inprogress" Link to this property "error" Link to this property
Link to this property url: Optional\[str] The URL to access the generated download. formaturi Link to this property
Link to this property
default: Optional\[Default] The default video download. Only present if this download type has been created. percent\_complete: float Indicates the progress as a percentage between 0 and 100. maximum100 minimum0 Link to this property
status: Literal\["ready", "inprogress", "error"] The status of a generated download. One of the following: "ready" Link to this property "inprogress" Link to this property "error" Link to this property
Link to this property url: Optional\[str] The URL to access the generated download. formaturi Link to this property
Link to this property
[Link to this property](<#(resource)%20stream.downloads%20%3E%20(model)%20download_get_response%20%3E%20(schema)>)
class DownloadCreateResponse: … An object with download type keys. Each key is optional and only present if that download type has been created.
audio: Optional\[Audio] The audio-only download. Only present if this download type has been created. percent\_complete: float Indicates the progress as a percentage between 0 and 100. maximum100 minimum0 Link to this property
status: Literal\["ready", "inprogress", "error"] The status of a generated download. One of the following: "ready" Link to this property "inprogress" Link to this property "error" Link to this property
Link to this property url: Optional\[str] The URL to access the generated download. formaturi Link to this property
Link to this property
default: Optional\[Default] The default video download. Only present if this download type has been created. percent\_complete: float Indicates the progress as a percentage between 0 and 100. maximum100 minimum0 Link to this property
status: Literal\["ready", "inprogress", "error"] The status of a generated download. One of the following: "ready" Link to this property "inprogress" Link to this property "error" Link to this property
Link to this property url: Optional\[str] The URL to access the generated download. formaturi Link to this property
Link to this property
[Link to this property](<#(resource)%20stream.downloads%20%3E%20(model)%20download_create_response%20%3E%20(schema)>) str [Link to this property](<#(resource)%20stream.downloads%20%3E%20(model)%20download_delete_response%20%3E%20(schema)>) #### StreamEmbed ##### [Deprecated: Retrieve legacy embed code HTML](https://developers.cloudflare.com/api/python/resources/stream/subresources/embed/methods/get) stream.embed.get(stridentifier, EmbedGetParams\*\*kwargs) -> [EmbedGetResponse]() GET/accounts/{account\_id}/stream/{identifier}/embed ##### ModelsExpand Collapse str [Link to this property](<#(resource)%20stream.embed%20%3E%20(model)%20embed_get_response%20%3E%20(schema)>) #### StreamToken ##### [Create signed URL tokens for videos](https://developers.cloudflare.com/api/python/resources/stream/subresources/token/methods/create) stream.token.create(stridentifier, TokenCreateParams\*\*kwargs) -> [TokenCreateResponse]() POST/accounts/{account\_id}/stream/{identifier}/token ##### ModelsExpand Collapse
class TokenCreateResponse: … token: Optional\[str] The signed token used with the signed URLs feature. Link to this property
[Link to this property](<#(resource)%20stream.token%20%3E%20(model)%20token_create_response%20%3E%20(schema)>)