API Reference

Stream

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Captions

List captions or subtitles

client.stream.captions.get(stringidentifier, CaptionGetParams { account_id } params, RequestOptionsoptions?): SinglePage<Caption { generated, label, language, status } >

GET/accounts/{account_id}/stream/{identifier}/captions

ModelsExpand Collapse

Caption { generated, label, language, status }

generated?: boolean

Whether the caption was generated via AI.

label?: string

The language label displayed in the native language to users.

language?: string

The language tag in BCP 47 format.

status?: "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

client.stream.captions.language.get(stringidentifier, stringlanguage, LanguageGetParams { account_id } params, RequestOptionsoptions?): Caption { generated, label, language, status }

GET/accounts/{account_id}/stream/{identifier}/captions/{language}

Generate captions or subtitles for a provided language via AI

client.stream.captions.language.create(stringidentifier, stringlanguage, LanguageCreateParams { account_id } params, RequestOptionsoptions?): Caption { generated, label, language, status }

POST/accounts/{account_id}/stream/{identifier}/captions/{language}/generate

Upload captions or subtitles

client.stream.captions.language.update(stringidentifier, stringlanguage, LanguageUpdateParams { account_id, file } params, RequestOptionsoptions?): Caption { generated, label, language, status }

PUT/accounts/{account_id}/stream/{identifier}/captions/{language}

Delete captions or subtitles

client.stream.captions.language.delete(stringidentifier, stringlanguage, LanguageDeleteParams { account_id } params, RequestOptionsoptions?): LanguageDeleteResponse

DELETE/accounts/{account_id}/stream/{identifier}/captions/{language}

ModelsExpand Collapse

LanguageDeleteResponse = string

CaptionsLanguageVtt

Return WebVTT captions for a provided language

client.stream.captions.language.vtt.get(stringidentifier, stringlanguage, VttGetParams { account_id } params, RequestOptionsoptions?): VttGetResponse

GET/accounts/{account_id}/stream/{identifier}/captions/{language}/vtt

ModelsExpand Collapse

VttGetResponse = string