Generar una descripción

La generación de descripciones usa IA para redactar la descripción de un vídeo a partir de una pista de texto existente. El idioma de la descripción coincide con el de la pista de texto de origen. La descripción generada se guarda en el objeto de vídeo.

Las funciones de IA requieren un plan con las funciones de IA habilitadas. El token de API que uses debe tener el permiso 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

Field	Required	Description
`length`	Sí	Longitud de la descripción: `short`, `default`, `long`.
`tone`	Sí	Tono de la descripción: `formal`, `default`.

Respuesta

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


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