Skip to content
Cloudflare API
Start here
API Reference
Stream

Captions

List captions or subtitles
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.

label: Optional[str]

The language label displayed in the native language to users.

language: Optional[str]

The language tag in BCP 47 format.

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

The status of a generated caption.

One of the following:
"ready"
"inprogress"
"error"

CaptionsLanguage

List captions or subtitles for a provided language
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
stream.captions.language.create(strlanguage, LanguageCreateParams**kwargs) -> Caption
POST/accounts/{account_id}/stream/{identifier}/captions/{language}/generate
Upload captions or subtitles
stream.captions.language.update(strlanguage, LanguageUpdateParams**kwargs) -> Caption
PUT/accounts/{account_id}/stream/{identifier}/captions/{language}
Delete captions or subtitles
stream.captions.language.delete(strlanguage, LanguageDeleteParams**kwargs) -> LanguageDeleteResponse
DELETE/accounts/{account_id}/stream/{identifier}/captions/{language}
ModelsExpand Collapse
str

CaptionsLanguageVtt

Return WebVTT captions for a provided language
stream.captions.language.vtt.get(strlanguage, VttGetParams**kwargs) -> VttGetResponse
GET/accounts/{account_id}/stream/{identifier}/captions/{language}/vtt
ModelsExpand Collapse
str