Show a caption

GET

/videos/{videoId}/captions/{language}

Display a caption for a video in a specific language. If the language is available, the caption is returned. Otherwise, you will get a response indicating the caption was not found.
Tutorials that use the captions endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://ws.api.video/videos/vi4k0jvEUuaTdRAEjQ4Prklg/captions/en'

Response Example

200 - response

{
    "default": false,
    "src": "https://cdn.api.video/vod/vi3N6cDinStg3oBbN79GklWS/captions/en.vtt",
    "srclang": "en",
    "uri": "/videos/vi3N6cDinStg3oBbN79GklWS/captions/en"
}

Request

Path Params

videoId

string

required

The unique identifier for the video you want captions for.

Example:

vi4k0jvEUuaTdRAEjQ4Prklg

language

string

required

A valid BCP 47 language representation

Example:

Responses

🟢200Success

application/json

Body

default

boolean

optional

Whether you will have subtitles or not. True for yes you will have subtitles, false for no you will not have subtitles.

Default:

false

Example:

false

src

string

optional

srclang

string

optional

uri

string

optional

🟠404Not Found

Modified at 2023-08-15 05:52:15

Delete a caption

Update caption