Captions

Update a caption

Update caption settings.

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

Path parameters

videoIdstring required

The unique identifier for the video you want to have automatic captions for.

languagestring required

A valid language identifier using IETF language tags. You can use primary subtags like en (English), extended subtags like fr-CA (French, Canada), or region subtags like zh-Hans-CN (Simplified Chinese used in the PRC).

This parameter only accepts dashes for separators, for example fr-CA. If you use a different separator in your request, the API returns an error.
When the value in your request does not match any covered language, the API returns an error.
You can find the list of supported tags here.

Request body

defaultboolean

Set this parameter to true to define a caption as the default for a video.

Response

Success

uristring

The unique resource identifier of the uploaded caption.

srcstring

A direct URL to the uploaded caption file.

srclangstring

Indicates the language of the uploaded caption file using IETF language tags.

languageNamestring

Returns the native name of the caption language in UTF-8 encoding.

defaultboolean

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

Example response

{
  "default": false,
  "src": "https://cdn.api.video/vod/vi1111DinStg3oBbN79GklWS/captions/sr-Cyrl.vtt",
  "srclang": "sr-Cyrl",
  "uri": "/videos/vi1111DinStg3oBbN79GklWS/captions/sr-Cyrl",
  "languageName": "српски (ћирилица)"
}

Changes

Changed in 4 of the 50 revisions of this API.107

Apr 16, 2024ec2b79bfdc8d1See the full diff
- ○
  added the non-success response with the status 429
  response-non-success-status-added
Nov 27, 202395cce3f1e0761See the full diff
- ○
  added the optional property languageName to the response with the 200 status
  response-optional-property-added
Apr 28, 2022f9532dd3578c2See the full diff
- ○
  the endpoint scheme security apiKey was added to the API
  api-security-added
- ○
  the endpoint scheme security bearerAuth was removed from the API
  api-security-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 7, 20222a4d90a64f88103See the full diff
- ●
  the optional response header X-RateLimit-Limit removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Limit removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Limit removed for the status 404
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Remaining removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Remaining removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Remaining removed for the status 404
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Retry-After removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Retry-After removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Retry-After removed for the status 404
  optional-response-header-removed
- ●
  removed the optional property languageName from the response with the 200 status
  response-optional-property-removed
- ○
  the endpoint scheme security bearerAuth was added to the API
  api-security-added
- ○
  the endpoint scheme security apiKey was removed from the API
  api-security-removed
- ○
  removed the non-success response with the status 429
  response-non-success-status-removed
This revision also has 32 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 50 revisions, 1 has no diff computed.

Full history