api.video

Update caption

PATCH

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

Captions

To have the captions on automatically, use this PATCH to set default: true.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://ws.api.video/videos/vi4k0jvEUuaTdRAEjQ4Prklg/captions/en' \
--header 'Content-Type: application/json' \
--data-raw '{
    "default": true
}'

Response Example

200 - response

{
  "default": true,
  "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 to have automatic captions for.

Example:

vi4k0jvEUuaTdRAEjQ4Prklg

language

string

required

A valid BCP 47 language representation.

Example:

Body Params application/json

default

boolean

optional

Examples

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

🟠400Bad Request

🟠404Not Found

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

Show a caption

Upload a caption