Cloudflare API

Audio Tracks

Stream.AudioTracks

Methods

client.stream.audioTracks.get(, , ):

Audio

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

Lists additional audio tracks on a video. Note this API will not return information for audio attached to the video upload.

client.stream.audioTracks.edit(, , , ):

Audio

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

Edits additional audio tracks on a video. Editing the default status of an audio track to true will mark all other audio tracks on the video default status to false.

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

AudioTrackDeleteResponse

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

Deletes additional audio tracks on a video. Deleting a default audio track is not allowed. You must assign another audio track as default prior to deletion.

client.stream.audioTracks.copy(, , ):

Audio

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

Adds an additional audio track to a video using the provided audio track URL.

Domain types

Audio{…}

Captions

Stream.Captions

Methods

client.stream.captions.get(, , ):

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

Lists the available captions or subtitles for a specific video.

Domain types

Caption{…}

Stream Captions

Language

Stream.Captions.Language

Methods

client.stream.captions.language.get(, , , ):

get/accounts/{account_id}/stream/{identifier}/captions/{language}

Lists the captions or subtitles for provided language.

client.stream.captions.language.create(, , , ):

post/accounts/{account_id}/stream/{identifier}/captions/{language}/generate

Generate captions or subtitles for provided language via AI.

client.stream.captions.language.update(, , , ):

put/accounts/{account_id}/stream/{identifier}/captions/{language}

Uploads the caption or subtitle file to the endpoint for a specific BCP47 language. One caption or subtitle file per language is allowed.

client.stream.captions.language.delete(, , , ):

LanguageDeleteResponse

delete/accounts/{account_id}/stream/{identifier}/captions/{language}

Removes the captions or subtitles from a video.

Stream Captions Language

Vtt

Stream.Captions.Language.Vtt

Methods

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

VttGetResponse

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

Return WebVTT captions for a provided language.

Clip

Stream.ClipResource

Methods

client.stream.clip.create(, ):

Clip

post/accounts/{account_id}/stream/clip

Clips a video based on the specified start and end times provided in seconds.

Domain types

Clip{…}

Copy

Stream.Copy

Methods

client.stream.copy.create(, ):

Video

post/accounts/{account_id}/stream/copy

Uploads a video to Stream from a provided URL.

DirectUploadCreateResponse

Direct Upload

Stream.DirectUpload

Methods

client.stream.directUpload.create(, ):

post/accounts/{account_id}/stream/direct_upload

Creates a direct upload that allows video uploads without an API key.

Downloads

Stream.Downloads

Methods

client.stream.downloads.get(, , ):

DownloadGetResponse

get/accounts/{account_id}/stream/{identifier}/downloads

Lists the downloads created for a video.

client.stream.downloads.create(, , ):

DownloadCreateResponse

post/accounts/{account_id}/stream/{identifier}/downloads

Creates a download for a video when a video is ready to view. Use /downloads/{download_type} instead for type-specific downloads. Available types are default and audio.

client.stream.downloads.delete(, , ):

DownloadDeleteResponse

delete/accounts/{account_id}/stream/{identifier}/downloads

Delete the downloads for a video. Use /downloads/{download_type} instead for type-specific downloads. Available types are default and audio.

Embed

Stream.Embed

Methods

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

EmbedGetResponse

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

Fetches an HTML code snippet to embed a video in a web page delivered through Cloudflare. On success, returns an HTML fragment for use on web pages to display a video. On failure, returns a JSON response body.

Keys

Stream.Keys

Methods

client.stream.keys.get(, ):

KeyGetResponse

get/accounts/{account_id}/stream/keys

Lists the video ID and creation date and time when a signing key was created.

client.stream.keys.create(, ):

Keys

post/accounts/{account_id}/stream/keys

Creates an RSA private key in PEM and JWK formats. Key files are only displayed once after creation. Keys are created, used, and deleted independently of videos, and every key can sign any video.

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

KeyDeleteResponse

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

Deletes signing keys and revokes all signed URLs generated with the key.

Domain types

Keys{…}

Live Inputs

Stream.LiveInputs

Methods

client.stream.liveInputs.list(, ):

LiveInputListResponse

get/accounts/{account_id}/stream/live_inputs

Lists the live inputs created for an account. To get the credentials needed to stream to a specific live input, request a single live input.

client.stream.liveInputs.get(, , ):

LiveInput

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

Retrieves details of an existing live input.

client.stream.liveInputs.create(, ):

LiveInput

post/accounts/{account_id}/stream/live_inputs

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

client.stream.liveInputs.update(, , ):

LiveInput

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

Updates a specified live input.

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

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

Prevents a live input from being streamed to and makes the live input inaccessible to any future API calls.

Domain types

LiveInput{…}

Details about a live input.

Stream Live Inputs

Outputs

Stream.LiveInputs.Outputs

Methods

client.stream.liveInputs.outputs.list(, , ):