Generare una descrizione

La generazione della descrizione usa l’IA per scrivere una descrizione del video a partire da un text track esistente. La lingua della descrizione corrisponde a quella del text track di origine. La descrizione generata viene salvata sull’oggetto video.

Le funzioni IA richiedono un piano con le funzioni IA abilitate. La chiave API che usi deve avere il permesso videos.update.

Generare una descrizione

Genera una descrizione inviando una richiesta POST all’endpoint /videos/:id/texttracks/:texttrackId/generate-description. Controlla l’output con i campi length e 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);

Parametri

Campo	Obbligatorio	Descrizione
`length`	Sì	Lunghezza della descrizione: `short`, `default`, `long`.
`tone`	Sì	Tono della descrizione: `formal`, `default`.

Risposta

La descrizione generata, che viene anche salvata sull’oggetto video.


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