Update Text Tracks

Update texttracks object

Updating texttracks is done by sending a PATCH request to the /videos/:videoId/texttracks/:texttrackId endpoint with either an attached VTT file or by passing the VTT content as a string.

Option 1: Provide VTT content as string

CURL


curl -X PATCH https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]/texttracks/[TEXTTRACK_ID] \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"language": "en", "type": "captions", "content": "[VTT_CONTENT]"}'

JavaScript / Node.js


const data = {
"language": "en" | "de" | "it" | "fr" | "...",
"type": "subtitles" | "captions",
"content": "[VTT_CONTENT]"
}
const response = await fetch(`https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]/texttracks/[TEXTTRACK_ID]`, {
method: 'PATCH',
body: JSON.stringify(data),
headers: {
  'Authorization': `Bearer YOUR_TOKEN`,
  'Content-Type': 'application/json'
}
});

PHP


$client = new GuzzleHttp\Client();
$data = [
  "language" => "en" | "de" | "it" | "fr" | "...",
  "type" => "subtitles" | "captions",
  "content" => "[VTT_CONTENT]"
];
$response = $client->request('PATCH', 'https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]/texttracks/[TEXTTRACK_ID]', [
'body' => json_encode($data),
'headers' => [
  'Authorization' => 'Bearer YOUR_TOKEN',
  'Content-Type' => 'application/json'
]
]);

Option 2: Provide VTT file

Content-Type has to be multipart/form-data and not application/json. The file and language have to be sent as part of the form data.

CURL


curl -X PATCH https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]/texttracks/[TEXTTRACK_ID] \
-H "Authorization: Bearer YOUR_TOKEN" \
-F "language=en" \
-F "type=captions" \
-F "file=@[PATH_TO_VTT_FILE]"

JavaScript / Node.js


const formData = new FormData();
formData.append('language', 'en');
formData.append('type', 'captions');
formData.append('file', [VTT_FILE]);
 
const response = await fetch(`https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]/texttracks/[TEXTTRACK_ID]`, {
method: 'PATCH',
body: formData,
headers: {
  'Authorization': `Bearer YOUR_TOKEN`,
}
});

PHP


$client = new GuzzleHttp\Client();
$response = $client->request('PATCH', 'https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]/texttracks/[TEXTTRACK_ID]', [
'multipart' => [
  [
    'name' => 'language',
    'contents' => 'en'
  ],
  [
    'name' => 'type',
    'contents' => 'captions'
  ],
  [
    'name' => 'file',
    'contents' => fopen('[PATH_TO_VTT_FILE]', 'r')
  ]
],
'headers' => [
  'Authorization' => 'Bearer YOUR_TOKEN'
]
]);

Response

The updated text track object.


{
  "id": string,
  "language": "en" | "de" | "it" | "fr" | "...",
  "type": "subtitles" | "captions",
  "filename": string,
  "url": string,
  "content": string
}