Generate a description

Description generation uses AI to write a video description from an existing text track. The description language matches the language of the source text track. The generated description is saved on the video object.

AI features require a plan with AI features enabled. The API token that you use must have the update permission.

Generate a description

Generate a description by sending a POST request to the /videos/:id/texttracks/:texttrackId/generate-description endpoint. Control the output with the length and tone fields.

CURL


curl -X POST https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]/texttracks/[TEXTTRACK_ID]/generate-description \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"length": "default", "tone": "default"}'

JavaScript / Node.js


const data = {
length: "default", // "short" | "default" | "long"
tone: "default"    // "formal" | "default"
};
 
const response = await fetch('https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]/texttracks/[TEXTTRACK_ID]/generate-description', {
method: 'POST',
body: JSON.stringify(data),
headers: {
  'Authorization': 'Bearer YOUR_TOKEN',
  'Content-Type': 'application/json'
}
});
 
const result = await response.json();

PHP


$client = new GuzzleHttp\Client();
$data = [
"length" => "default", // "short" | "default" | "long"
"tone" => "default"    // "formal" | "default"
];
 
$response = $client->request('POST', 'https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]/texttracks/[TEXTTRACK_ID]/generate-description', [
'body' => json_encode($data),
'headers' => [
  'Authorization' => 'Bearer YOUR_TOKEN',
  'Content-Type' => 'application/json'
]
]);
 
$result = json_decode($response->getBody(), true);

Parameters

Field	Required	Description
`length`	Yes	Length of the description: `short`, `default`, `long`.
`tone`	Yes	Tone of the description: `formal`, `default`.

Response

The generated description, which is also saved on the video object.


{
  "description": string,
  "message": "Description successfully generated and saved"
}