List captions or subtitles

GET

https://api.cloudflare.com/client/v4/accounts/{account_identifier}/stream/{identifier}/captions

Last modified:2022-12-16 13:48:37

Lists the available captions or subtitles for a specific video.

Request

Path Params

identifier

string

required

account_identifier

string

required

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200List captions or subtitles response

application/json

Body

result

required

Any of

allOf {2}

array[object (captions) {2}]

allOf {2}

One of

array[object (captions) {2}]

object

label

string

label

read-onlyoptional

The language label displayed in the native language to users.

Example:

Türkçe

language

string

language

read-onlyoptional

The language tag in BCP 47 format.

Example:

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "label": "Türkçe",
            "language": "tr"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

🟢200List captions or subtitles response failure

Modified at 2022-12-16 13:48:37

Delete signing keys

Delete captions or subtitles