Generar una descripción

La generación de descripciones usa IA para escribir la descripción de un vídeo a partir de un text track existente. El idioma de la descripción coincide con el idioma del text track de origen. La descripción generada se guarda en el objeto del vídeo.

Las funciones de IA requieren un plan con las funciones de IA habilitadas. La Clave API que uses debe tener el permiso videos.update.

Generar una descripción

Genera una descripción enviando una solicitud POST al endpoint /videos/:id/texttracks/:texttrackId/generate-description. Controla el resultado con los campos length y 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);

Parámetros

Campo	Obligatorio	Descripción
`length`	Sí	Longitud de la descripción: `short`, `default`, `long`.
`tone`	Sí	Tono de la descripción: `formal`, `default`.

Respuesta

La descripción generada también se guarda en el objeto del vídeo.


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