captions
Creates, updates, deletes, gets or lists a captions resource.
Overview
| Name | captions |
| Type | Resource |
| Id | cloudflare.streams.captions |
Fields
The following fields are returned by SELECT queries:
- list
List captions or subtitles response.
| Name | Datatype | Description |
|---|---|---|
generated | boolean | Whether the caption was generated via AI. |
label | string | The language label displayed in the native language to users. (example: Türkçe) |
language | string | The language tag in BCP 47 format. (example: tr) |
status | string | The status of a generated caption. (ready, inprogress, error) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | identifier, account_id | Lists the available captions or subtitles for a specific video. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
account_id | string | The Cloudflare account ID. |
identifier | string | Resource identifier. |
SELECT examples
- list
Lists the available captions or subtitles for a specific video.
SELECT
generated,
label,
language,
status
FROM cloudflare.streams.captions
WHERE identifier = '{{ identifier }}' -- required
AND account_id = '{{ account_id }}' -- required
;