Beschreibung generieren

Die Beschreibungsgenerierung nutzt KI, um aus einer bestehenden Textspur eine Videobeschreibung zu schreiben. Die Sprache der Beschreibung entspricht der Sprache der Quell-Textspur. Die generierte Beschreibung wird im Video-Objekt gespeichert.

KI-Funktionen erfordern einen Plan mit aktivierten KI-Funktionen. Der API-Token, den du verwendest, muss die Berechtigung update haben.

Beschreibung generieren

Generiere eine Beschreibung, indem du eine POST-Anfrage an den Endpoint /videos/:id/texttracks/:texttrackId/generate-description sendest. Steuere die Ausgabe über die Felder length und 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);

Parameter

Field	Required	Description
`length`	Ja	Länge der Beschreibung: `short`, `default`, `long`.
`tone`	Ja	Tonalität der Beschreibung: `formal`, `default`.

Antwort

Die generierte Beschreibung, die außerdem im Video-Objekt gespeichert wird.


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