Skip to content
Start here

Captions

List captions or subtitles
GET/accounts/{account_id}/stream/{identifier}/captions
ModelsExpand Collapse
Caption { generated, label, language, status }
generated: optional boolean

Whether the caption was generated via AI.

label: optional string

The language label displayed in the native language to users.

language: optional string

The language tag in BCP 47 format.

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

The status of a generated caption.

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

CaptionsLanguage

List captions or subtitles for a provided language
GET/accounts/{account_id}/stream/{identifier}/captions/{language}
Generate captions or subtitles for a provided language via AI
POST/accounts/{account_id}/stream/{identifier}/captions/{language}/generate
Upload captions or subtitles
PUT/accounts/{account_id}/stream/{identifier}/captions/{language}
Delete captions or subtitles
DELETE/accounts/{account_id}/stream/{identifier}/captions/{language}
ModelsExpand Collapse
LanguageDeleteResponse = string

CaptionsLanguageVtt

Return WebVTT captions for a provided language
GET/accounts/{account_id}/stream/{identifier}/captions/{language}/vtt
ModelsExpand Collapse
VttGetResponse = string