Gerar uma descrição

A geração de descrições usa IA para escrever uma descrição de vídeo a partir de uma faixa de texto existente. O idioma da descrição corresponde ao idioma da faixa de texto de origem. A descrição gerada é guardada no objeto do vídeo.

As funções de IA exigem um plano com funções de IA ativadas. O token de API que usas tem de ter a permissão update.

Gerar uma descrição

Gera uma descrição enviando um pedido POST para o endpoint /videos/:id/texttracks/:texttrackId/generate-description. Controla o resultado com os campos 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);

Parâmetros

Campo	Obrigatório	Descrição
`length`	Sim	Comprimento da descrição: `short`, `default`, `long`.
`tone`	Sim	Tom da descrição: `formal`, `default`.

Resposta

A descrição gerada, que é também guardada no objeto do vídeo.


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