Skip to content
Start here

Downloads

List downloads
stream.downloads.get(stridentifier, DownloadGetParams**kwargs) -> DownloadGetResponse
GET/accounts/{account_id}/stream/{identifier}/downloads
Create downloads
stream.downloads.create(stridentifier, DownloadCreateParams**kwargs) -> DownloadCreateResponse
POST/accounts/{account_id}/stream/{identifier}/downloads
Delete downloads
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: Optional[float]

Indicates the progress as a percentage between 0 and 100.

maximum100
minimum0
status: Optional[Literal["ready", "inprogress", "error"]]

The status of a generated download.

One of the following:
"ready"
"inprogress"
"error"
url: Optional[str]

The URL to access the generated download.

formaturi
default: Optional[Default]

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

percent_complete: Optional[float]

Indicates the progress as a percentage between 0 and 100.

maximum100
minimum0
status: Optional[Literal["ready", "inprogress", "error"]]

The status of a generated download.

One of the following:
"ready"
"inprogress"
"error"
url: Optional[str]

The URL to access the generated download.

formaturi
class DownloadCreateResponse:
percent_complete: Optional[float]

Indicates the progress as a percentage between 0 and 100.

maximum100
minimum0
status: Optional[Literal["ready", "inprogress", "error"]]

The status of a generated download.

One of the following:
"ready"
"inprogress"
"error"
url: Optional[str]

The URL to access the generated download.

formaturi
str