---
title: Captions
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/typescript)

[Stream](https://developers.cloudflare.com/api/typescript/resources/stream)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Captions

##### [List captions or subtitles](https://developers.cloudflare.com/api/typescript/resources/stream/subresources/captions/methods/get)

client.stream.captions.get(stringidentifier, CaptionGetParams {account\_id } params, RequestOptionsoptions?): SinglePage< [Caption](<https://developers.cloudflare.com/api/typescript/resources/stream#(resource)%20stream.captions%20%3E%20(model)%20caption%20%3E%20(schema)>) {generated, label, language, status } >

GET/accounts/{account\_id}/stream/{identifier}/captions

##### ModelsExpand Collapse

<details>

<summary>

Caption {generated, label, language, status }

</summary>

generated?: boolean

Whether the caption was generated via AI.

<a href="#(resource)%20stream.captions%20%3E%20(model)%20caption%20%3E%20(schema)%20%3E%20(property)%20generated">Link to this property</a>

label?: string

The language label displayed in the native language to users.

<a href="#(resource)%20stream.captions%20%3E%20(model)%20caption%20%3E%20(schema)%20%3E%20(property)%20label">Link to this property</a>

language?: string

The language tag in BCP 47 format.

<a href="#(resource)%20stream.captions%20%3E%20(model)%20caption%20%3E%20(schema)%20%3E%20(property)%20language">Link to this property</a>

<details>

<summary>

status?: "ready"| "inprogress"| "error"

The status of a generated caption.

</summary>

One of the following:

"ready"

<a href="#(resource)%20stream.captions%20%3E%20(model)%20caption%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%200">Link to this property</a>

"inprogress"

<a href="#(resource)%20stream.captions%20%3E%20(model)%20caption%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%201">Link to this property</a>

"error"

<a href="#(resource)%20stream.captions%20%3E%20(model)%20caption%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%202">Link to this property</a>

</details>

<a href="#(resource)%20stream.captions%20%3E%20(model)%20caption%20%3E%20(schema)%20%3E%20(property)%20status">Link to this property</a>

</details>

[Link to this property](<#(resource)%20stream.captions%20%3E%20(model)%20caption%20%3E%20(schema)>)

#### CaptionsLanguage

##### [List captions or subtitles for a provided language](https://developers.cloudflare.com/api/typescript/resources/stream/subresources/captions/subresources/language/methods/get)

client.stream.captions.language.get(stringlanguage, LanguageGetParams {account\_id, identifier } params, RequestOptionsoptions?): [Caption](<https://developers.cloudflare.com/api/typescript/resources/stream#(resource)%20stream.captions%20%3E%20(model)%20caption%20%3E%20(schema)>) {generated, label, language, status }

GET/accounts/{account\_id}/stream/{identifier}/captions/{language}

##### [Generate captions or subtitles for a provided language via AI](https://developers.cloudflare.com/api/typescript/resources/stream/subresources/captions/subresources/language/methods/create)

client.stream.captions.language.create(stringlanguage, LanguageCreateParams {account\_id, identifier } params, RequestOptionsoptions?): [Caption](<https://developers.cloudflare.com/api/typescript/resources/stream#(resource)%20stream.captions%20%3E%20(model)%20caption%20%3E%20(schema)>) {generated, label, language, status }

POST/accounts/{account\_id}/stream/{identifier}/captions/{language}/generate

##### [Upload captions or subtitles](https://developers.cloudflare.com/api/typescript/resources/stream/subresources/captions/subresources/language/methods/update)

client.stream.captions.language.update(stringlanguage, LanguageUpdateParams {account\_id, identifier, file } params, RequestOptionsoptions?): [Caption](<https://developers.cloudflare.com/api/typescript/resources/stream#(resource)%20stream.captions%20%3E%20(model)%20caption%20%3E%20(schema)>) {generated, label, language, status }

PUT/accounts/{account\_id}/stream/{identifier}/captions/{language}

##### [Delete captions or subtitles](https://developers.cloudflare.com/api/typescript/resources/stream/subresources/captions/subresources/language/methods/delete)

client.stream.captions.language.delete(stringlanguage, LanguageDeleteParams {account\_id, identifier } params, RequestOptionsoptions?): [LanguageDeleteResponse](<https://developers.cloudflare.com/api/typescript/resources/stream#(resource)%20stream.captions.language%20%3E%20(model)%20language_delete_response%20%3E%20(schema)>)

DELETE/accounts/{account\_id}/stream/{identifier}/captions/{language}

##### ModelsExpand Collapse

LanguageDeleteResponse = string

[Link to this property](<#(resource)%20stream.captions.language%20%3E%20(model)%20language_delete_response%20%3E%20(schema)>)

#### CaptionsLanguageVtt

##### [Return WebVTT captions for a provided language](https://developers.cloudflare.com/api/typescript/resources/stream/subresources/captions/subresources/language/subresources/vtt/methods/get)

client.stream.captions.language.vtt.get(stringlanguage, VttGetParams {account\_id, identifier } params, RequestOptionsoptions?): [VttGetResponse](<https://developers.cloudflare.com/api/typescript/resources/stream#(resource)%20stream.captions.language.vtt%20%3E%20(model)%20vtt_get_response%20%3E%20(schema)>)

GET/accounts/{account\_id}/stream/{identifier}/captions/{language}/vtt

##### ModelsExpand Collapse

VttGetResponse = string

[Link to this property](<#(resource)%20stream.captions.language.vtt%20%3E%20(model)%20vtt_get_response%20%3E%20(schema)>)