Skip to content
Start here

Downloads

List downloads
GET/accounts/{account_id}/stream/{identifier}/downloads
Create downloads
POST/accounts/{account_id}/stream/{identifier}/downloads
Delete downloads
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: optional { percentComplete, status, url }

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

percentComplete: optional number

Indicates the progress as a percentage between 0 and 100.

maximum100
minimum0
status: optional "ready" or "inprogress" or "error"

The status of a generated download.

One of the following:
"ready"
"inprogress"
"error"
url: optional string

The URL to access the generated download.

formaturi
default: optional { percentComplete, status, url }

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

percentComplete: optional number

Indicates the progress as a percentage between 0 and 100.

maximum100
minimum0
status: optional "ready" or "inprogress" or "error"

The status of a generated download.

One of the following:
"ready"
"inprogress"
"error"
url: optional string

The URL to access the generated download.

formaturi
DownloadCreateResponse { percentComplete, status, url }
percentComplete: optional number

Indicates the progress as a percentage between 0 and 100.

maximum100
minimum0
status: optional "ready" or "inprogress" or "error"

The status of a generated download.

One of the following:
"ready"
"inprogress"
"error"
url: optional string

The URL to access the generated download.

formaturi
DownloadDeleteResponse = string