Skip to main content
POST
Add Caption

Authorizations

AccessKey
string
header
required

AccessKey based authentication

Path Parameters

libraryId
integer<int64>
required

The ID of the video library.

videoId
string
required

The GUID of the video.

srclang
string
required

The srclang shortcode for the caption, e.g. "en".

Body

application/json
srclang
string | null
deprecated

Not used — the caption's srclang is taken from the srclang route segment instead. Any value sent here is ignored.

label
string | null

The text description label for the caption

captionsFile
string | null

Base64 encoded captions file

Response

The caption was successfully uploaded

success
boolean

Determines if the request was successful

message
string | null

Human-readable message describing the result, typically populated with error details when Success is false.

statusCode
integer<int32>

The HTTP status code corresponding to the result of the request.

data
object | null

The response payload. Some endpoints also populate this with error details when Success is false — see the endpoint's own response documentation.

Last modified on September 10, 2026