Skip to content
Cloudflare API
Start here
API Reference
Stream

Downloads

List downloads
client.stream.downloads.get(stringidentifier, DownloadGetParams { account_id } params?, RequestOptionsoptions?): DownloadGetResponse { audio, default }
GET/accounts/{account_id}/stream/{identifier}/downloads
Create downloads
client.stream.downloads.create(stringidentifier, DownloadCreateParams { account_id } params?, RequestOptionsoptions?): DownloadCreateResponse { audio, default }
POST/accounts/{account_id}/stream/{identifier}/downloads
Delete downloads
client.stream.downloads.delete(stringidentifier, DownloadDeleteParams { account_id } params?, RequestOptionsoptions?): DownloadDeleteResponse
DELETE/accounts/{account_id}/stream/{identifier}/downloads
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 { 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
DownloadDeleteResponse = string