Generowanie opisu

Generowanie opisu używa AI do napisania opisu wideo na podstawie istniejącego text track. Język opisu odpowiada językowi źródłowego text track. Wygenerowany opis jest zapisywany na obiekcie wideo.

Funkcje AI wymagają planu z włączonymi funkcjami AI. Klucz API, którego używasz, musi mieć uprawnienie videos.update.

Generowanie opisu

Wygeneruj opis, wysyłając żądanie POST na endpoint /videos/:id/texttracks/:texttrackId/generate-description. Steruj wynikiem polami length i 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);

Parametry

Field	Required	Description
`length`	Tak	Długość opisu: `short`, `default`, `long`.
`tone`	Tak	Ton opisu: `formal`, `default`.

Odpowiedź

Wygenerowany opis, który jest też zapisywany na obiekcie wideo.


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