Générer une description

La génération de description utilise l’IA pour rédiger une description de vidéo à partir d’une piste de texte existante. La langue de la description correspond à celle de la piste de texte source. La description générée est enregistrée sur l’objet vidéo.

Les fonctions IA nécessitent un plan avec les fonctions IA activées. Le token API que tu utilises doit avoir la permission update.

Générer une description

Génère une description en envoyant une requête POST à l’endpoint /videos/:id/texttracks/:texttrackId/generate-description. Contrôle la sortie avec les champs length et tone.

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);

Paramètres

Field	Required	Description
`length`	Oui	Longueur de la description : `short`, `default`, `long`.
`tone`	Oui	Ton de la description : `formal`, `default`.

Réponse

La description générée, qui est aussi enregistrée sur l’objet vidéo.


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