> ## Documentation Index
> Fetch the complete documentation index at: https://gccai.heqingsong.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# Génération vidéo Kling v3 Omni

>  - Mode de traitement asynchrone, renvoie un identifiant de tâche pour les requêtes ultérieures
- Interface unifiée text-to-video / image-to-video avec syntaxe de référence d'image
- Prend en charge le mode standard (720P), le mode professionnel (1080P) et le mode 4K
- Référencement d'images dans les prompts via la syntaxe image_N
- Prend en charge la génération de vidéos avec audio (mutuellement exclusif avec video_list) 

```bash cURL theme={null}
curl --request POST \
  --url https://gccai.heqingsong.uk/v1/videos/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "kling-v3-omni",
    "prompt": "Make the person in <<<image_1>>> wave at the camera",
    "image_urls": ["https://upload.gccai.ai/f/models/9998230426123070-e9d6af04-cb5e-4731-8ae7-abf144cb0d29-9998230586368386-29641169-f698-4ab9-9b6d-380899e6521e-9998230593110693-c1741a3a-.webp"],
    "mode": "std",
    "duration": 5,
    "aspect_ratio": "16:9"
  }'
```

```python Python theme={null}
import requests

url = "https://gccai.heqingsong.uk/v1/videos/generations"

payload = {
    "model": "kling-v3-omni",
    "prompt": "Make the person in <<<image_1>>> wave at the camera",
    "image_urls": ["https://upload.gccai.ai/f/models/9998230426123070-e9d6af04-cb5e-4731-8ae7-abf144cb0d29-9998230586368386-29641169-f698-4ab9-9b6d-380899e6521e-9998230593110693-c1741a3a-.webp"],
    "mode": "std",
    "duration": 5,
    "aspect_ratio": "16:9"
}

headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript JavaScript theme={null}
const url = "https://gccai.heqingsong.uk/v1/videos/generations";

const payload = {
  model: "kling-v3-omni",
  prompt: "Make the person in <<<image_1>>> wave at the camera",
  image_urls: ["https://upload.gccai.ai/f/models/9998230426123070-e9d6af04-cb5e-4731-8ae7-abf144cb0d29-9998230586368386-29641169-f698-4ab9-9b6d-380899e6521e-9998230593110693-c1741a3a-.webp"],
  mode: "std",
  duration: 5,
  aspect_ratio: "16:9"
};

const headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
};

fetch(url, {
  method: "POST",
  headers: headers,
  body: JSON.stringify(payload)
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));
```

```go Go theme={null}
package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "io/ioutil"
    "net/http"
)

func main() {
    url := "https://gccai.heqingsong.uk/v1/videos/generations"

    payload := map[string]interface{}{
        "model":        "kling-v3-omni",
        "prompt":       "Make the person in <<<image_1>>> wave at the camera",
        "image_urls":   []string{"https://upload.gccai.ai/f/models/9998230426123070-e9d6af04-cb5e-4731-8ae7-abf144cb0d29-9998230586368386-29641169-f698-4ab9-9b6d-380899e6521e-9998230593110693-c1741a3a-.webp"},
        "mode":         "std",
        "duration":     5,
        "aspect_ratio": "16:9",
    }

    jsonData, _ := json.Marshal(payload)

    req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
    req.Header.Set("Authorization", "Bearer <token>")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := ioutil.ReadAll(resp.Body)
    fmt.Println(string(body))
}
```

```java Java theme={null}
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;

public class Main {
    public static void main(String[] args) throws Exception {
        String url = "https://gccai.heqingsong.uk/v1/videos/generations";

        String payload = """
        {
          "model": "kling-v3-omni",
          "prompt": "Make the person in <<<image_1>>> wave at the camera",
          "image_urls": ["https://upload.gccai.ai/f/models/9998230426123070-e9d6af04-cb5e-4731-8ae7-abf144cb0d29-9998230586368386-29641169-f698-4ab9-9b6d-380899e6521e-9998230593110693-c1741a3a-.webp"],
          "mode": "std",
          "duration": 5,
          "aspect_ratio": "16:9"
        }
        """;

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(url))
            .header("Authorization", "Bearer <token>")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(payload))
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
```

```php PHP theme={null}
<?php

$url = "https://gccai.heqingsong.uk/v1/videos/generations";

$payload = [
    "model" => "kling-v3-omni",
    "prompt" => "Make the person in <<<image_1>>> wave at the camera",
    "image_urls" => ["https://upload.gccai.ai/f/models/9998230426123070-e9d6af04-cb5e-4731-8ae7-abf144cb0d29-9998230586368386-29641169-f698-4ab9-9b6d-380899e6521e-9998230593110693-c1741a3a-.webp"],
    "mode" => "std",
    "duration" => 5,
    "aspect_ratio" => "16:9"
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
```

```ruby Ruby theme={null}
require 'net/http'
require 'json'
require 'uri'

url = URI("https://gccai.heqingsong.uk/v1/videos/generations")

payload = {
  model: "kling-v3-omni",
  prompt: "Make the person in <<<image_1>>> wave at the camera",
  image_urls: ["https://upload.gccai.ai/f/models/9998230426123070-e9d6af04-cb5e-4731-8ae7-abf144cb0d29-9998230586368386-29641169-f698-4ab9-9b6d-380899e6521e-9998230593110693-c1741a3a-.webp"],
  mode: "std",
  duration: 5,
  aspect_ratio: "16:9"
}

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = payload.to_json

response = http.request(request)
puts response.body
```

```swift Swift theme={null}
import Foundation

let url = URL(string: "https://gccai.heqingsong.uk/v1/videos/generations")!

let payload: [String: Any] = [
    "model": "kling-v3-omni",
    "prompt": "Make the person in <<<image_1>>> wave at the camera",
    "image_urls": ["https://upload.gccai.ai/f/models/9998230426123070-e9d6af04-cb5e-4731-8ae7-abf144cb0d29-9998230586368386-29641169-f698-4ab9-9b6d-380899e6521e-9998230593110693-c1741a3a-.webp"],
    "mode": "std",
    "duration": 5,
    "aspect_ratio": "16:9"
]

var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("Bearer <token>", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = try? JSONSerialization.data(withJSONObject: payload)

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    if let error = error {
        print("Error: \(error)")
        return
    }

    if let data = data, let responseString = String(data: data, encoding: .utf8) {
        print(responseString)
    }
}

task.resume()
```

```csharp C# theme={null}
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var url = "https://gccai.heqingsong.uk/v1/videos/generations";

        var payload = @"{
            ""model"": ""kling-v3-omni"",
            ""prompt"": ""Make the person in <<<image_1>>> wave at the camera"",
            ""image_urls"": [""https://upload.gccai.ai/f/models/9998230426123070-e9d6af04-cb5e-4731-8ae7-abf144cb0d29-9998230586368386-29641169-f698-4ab9-9b6d-380899e6521e-9998230593110693-c1741a3a-.webp""],
            ""mode"": ""std"",
            ""duration"": 5,
            ""aspect_ratio"": ""16:9""
        }";

        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("Authorization", "Bearer <token>");

        var content = new StringContent(payload, Encoding.UTF8, "application/json");
        var response = await client.PostAsync(url, content);
        var result = await response.Content.ReadAsStringAsync();

        Console.WriteLine(result);
    }
}
```

```json 200 theme={null}
{
  "code": 200,
  "data": [
    {
      "status": "submitted",
      "task_id": "task_xxxxxxxxxx"
    }
  ]
}
```

```json 400 theme={null}
{
  "error": {
    "code": 400,
    "message": "Invalid request parameters",
    "type": "invalid_request_error"
  }
}
```

```json 401 theme={null}
{
  "error": {
    "code": 401,
    "message": "Invalid authentication credentials",
    "type": "authentication_error"
  }
}
```

```json 402 theme={null}
{
  "error": {
    "code": 402,
    "message": "Insufficient balance. Please top up your account",
    "type": "payment_required"
  }
}
```

```json 429 theme={null}
{
  "error": {
    "code": 429,
    "message": "Rate limit exceeded. Please try again later",
    "type": "rate_limit_error"
  }
}
```

```json 500 theme={null}
{
  "error": {
    "code": 500,
    "message": "Internal server error. Please try again later",
    "type": "server_error"
  }
}
```

## Autorisation

**Authorization** `string` *required*

Tous les points de terminaison API nécessitent une authentification par Bearer Token

Obtenir votre clé API :

Rendez-vous sur la [page de gestion des clés API](https://gccai.heqingsong.uk/keys) pour obtenir votre clé API

Ajoutez-la à l'en-tête de la requête :

```
Authorization: Bearer YOUR_API_KEY
```

## Paramètres de la requête

**model** `string` *required*

Nom du modèle de génération vidéo

Modèles pris en charge :

* `kling-v3-omni` — Kling v3 Omni (interface unifiée)

**nsfw\_check** `boolean` (default: false)

Indique s'il faut modérer le contenu avant d'envoyer la tâche vidéo.

* `true` : vérifier les prompts et les images d'entrée avec `omni-moderation-latest`
* `false` ou omis : ne pas envoyer de requête de modération, sans coût ni latence de modération supplémentaires (par défaut)

**prompt** `string` *required*

Prompt textuel positif

Permet de référencer les images de `image_urls` via la syntaxe `<<<image_N>>>`, où `N` commence à 1.

Exemple : `"Make the person in <<<image_1>>> wave at the camera"`

> [!NOTE]
>
> Si des images sont fournies mais que le prompt ne contient aucune référence `<<<image_N>>>`, le système ajoute automatiquement `<<<image_1>>>` au début du prompt.

**negative\_prompt** `string`

Prompt négatif utilisé pour exclure les contenus indésirables. Longueur maximale : 2500 caractères.

**mode** `string` (default: std)

Mode de génération

Options :

* `std` — mode standard (720P)
* `pro` — mode professionnel (1080P)
* `4k` — mode 4K Ultra HD

Par défaut : `std`

**duration** `integer` (default: 5)

Par défaut : `5`
Durée de la vidéo (en secondes)

Plage : 3 à 15 (minimum 3 secondes, maximum 15 secondes)

**⚠️ Note :** doit être un nombre simple (par ex. `6`), sans guillemets, sinon une erreur se produira

**aspect\_ratio** `string` (default: 16:9)

Format d'image de la vidéo

Options :

* `16:9` — paysage
* `9:16` — portrait
* `1:1` — carré

Par défaut : `16:9`

**image\_urls** `array\<url\>`

Tableau d'URL d'images pour le référencement d'images

Référencez les images correspondantes dans le prompt via la syntaxe `<<<image_N>>>` (N commence à 1)

Exemple : `["https://example.com/photo.jpg"]`

> [!WARNING]
>
> * Les URL d'images doivent être publiquement accessibles, sans protection anti-hotlink
> * En mode image-to-video, `aspect_ratio` peut être remplacé par le rapport réel de l'image

**image\_with\_roles** `array\<object\>`

Tableau d'images avec rôles, recommandé pour l'image-to-video.

Format de chaque élément : `{ "url": "...", "role": "..." }`

* `first_frame` : première image
* `last_frame` : dernière image
* `reference` : image de référence

> [!WARNING]
>
> `image_urls` et `image_with_roles` sont mutuellement exclusifs. N'en utilisez qu'un seul.

**video\_list** `array`

Liste de vidéos de référence (basée sur URL), jusqu'à 1 vidéo.

Utilisez `refer_type` pour distinguer les types :

* `base` : vidéo à éditer (par défaut)
* `feature` : vidéo de référence de caractéristiques

Utilisez `keep_original_sound` pour contrôler l'audio d'origine :

* `no` : ne pas conserver (par défaut)
* `yes` : conserver le son d'origine

Format de la requête :

```json theme={null}
"video_list":[
  { "video_url": "video_url", "refer_type": "base", "keep_original_sound": "no" }
]
```

> [!WARNING]
>
> * `video_url` ne peut pas être vide, et l'URL de la vidéo doit être accessible
> * Lorsque `refer_type=base` :
>   * Les images de début/fin ne peuvent pas être définies
>   * La vidéo de référence doit durer 3 à 10 secondes
>   * La durée de la vidéo générée suit celle de la vidéo téléversée
> * Lorsque `refer_type=feature` et que `video_url` n'est pas vide :
>   * `image_urls` ne peut contenir qu'une image de première image
> * Exigences vidéo : MP4/MOV uniquement ; durée d'au moins 3 secondes ; résolution 720–2160 px ; fréquence d'images 24–60 fps (la sortie est de 24 fps) ; taille maximale 200 Mo

**multi\_shot** `boolean` (default: false)

Activer ou non le mode multi-plans.

**shot\_type** `string`

Méthode de découpage des plans : `customize` / `intelligence`.

Obligatoire lorsque `multi_shot=true`.

**multi\_prompt** `array\<object\>`

Liste multi-plans, chaque élément est `{ index, prompt, duration }`.

* Minimum 1 plan, maximum 6 plans
* Chaque `duration` de plan doit être un entier >= 1
* La somme des durées de tous les plans doit être égale à la `duration` de premier niveau
* `index` doit commencer à 1 et augmenter de manière continue
* Obligatoire lorsque `multi_shot=true` et `shot_type=customize`

Exemple :

```json theme={null}
[
  { "index": 1, "prompt": "a happy dog in running@element_cat", "duration": 3 },
  { "index": 2, "prompt": "a happy dog play with a cat@element_dog", "duration": 3 }
]
```

**element\_list** `array\<object\>`

Liste des sujets de référence, jusqu'à 3 sujets. Prend en charge :

* La création de sujets à la volée avec `name`, `description`, `element_input_urls`

Format général :

```json theme={null}
[
  {
    "name": "element_dog",
    "description": "a golden retriever, fluffy fur, friendly expression",
    "element_input_urls": [
      "https://example.com/image1.png",
      "https://example.com/image2.png"
    ]
  },
  {
    "name": "element_cat",
    "description": "an orange tabby cat, round face, bright eyes",
    "element_input_urls": [
      "https://example.com/image1.png",
      "https://example.com/image2.png"
    ]
  }
]
```

Notes :

* Pour la création à la volée, `name`, `description`, `element_input_urls` sont obligatoires
* `element_input_urls` : 2 à 4 images par sujet (la première comme image frontale, les autres comme références)
* Utilisez `@name` dans `prompt`, par ex. `"@element_dog and @element_cat are playing on the grass"`

**watermark** `boolean`

Ajouter ou non un filigrane

**audio** `boolean` (default: false)

Générer ou non la vidéo avec audio

> [!WARNING]
>
> Ce paramètre est mutuellement exclusif avec `video_list`.
>
> Lorsque `video_list` a une valeur, le paramètre `audio` n'est pas nécessaire.

### Contraintes et limites des paramètres

* `image_urls` et `image_with_roles` sont mutuellement exclusifs
* `mode=4k` est disponible pour `kling-v3-omni`
* L'entrée de la dernière image seule (`last_frame` sans première image) est invalide
* Les images de début/fin et l'édition vidéo sont mutuellement exclusives : lorsque `video_list.refer_type=base` (ou omis), les images de début/fin ne sont pas autorisées
* Lorsque `video_list` est présent, `audio` est ignoré
* `video_list` prend en charge au maximum 1 vidéo
* `multi_prompt` prend en charge jusqu'à 6 plans, avec `index` commençant à 1 et augmentant de manière continue

## Syntaxe de référence d'image

Le modèle Omni utilise la syntaxe `<<<image_N>>>` pour référencer des images dans les prompts, offrant une expérience unifiée text-to-video / image-to-video :

| Syntaxe | Description |
| - | - |
| `<<<image_1>>>` | Référence la 1re image du tableau `image_urls` |
| `<<<image_2>>>` | Référence la 2e image du tableau `image_urls` |

> [!NOTE]
>
> **Référence automatique** : si `image_urls` est fourni mais que le prompt ne contient aucune référence `<<<image_N>>>`, le système ajoute automatiquement `<<<image_1>>>` au début du prompt.

## Réponse

**code** `integer`

Code de statut de la réponse, 200 en cas de succès

**data** `array`

Tableau de données de la réponse

**Éléments du tableau**

**status** `string`

Statut de la tâche, `submitted` lors de la soumission initiale

**task\_id** `string`

Identifiant unique de la tâche, utilisé pour interroger son statut et ses résultats

## Cas d'usage

### Cas 1 : Texte vers vidéo (mode standard)

```json theme={null}
{
  "model": "kling-v3-omni",
  "prompt": "A golden retriever running on the beach, sunset, cinematic",
  "mode": "std",
  "duration": 5,
  "aspect_ratio": "16:9"
}
```

### Cas 2 : Référence d'image (image unique)

```json theme={null}
{
  "model": "kling-v3-omni",
  "prompt": "Make the person in <<<image_1>>> wave at the camera",
  "image_urls": ["https://upload.gccai.ai/f/models/9998230426123070-e9d6af04-cb5e-4731-8ae7-abf144cb0d29-9998230586368386-29641169-f698-4ab9-9b6d-380899e6521e-9998230593110693-c1741a3a-.webp"],
  "mode": "pro",
  "duration": 5
}
```

### Cas 3 : Références à plusieurs images

```json theme={null}
{
  "model": "kling-v3-omni",
  "prompt": "The character in <<<image_1>>> walks toward the scene in <<<image_2>>>",
  "image_urls": [
    "https://example.com/character.jpg",
    "https://example.com/scene.jpg"
  ],
  "mode": "pro",
  "duration": 5
}
```

### Cas 4 : Image fournie sans référence explicite (ajoutée automatiquement)

```json theme={null}
{
  "model": "kling-v3-omni",
  "prompt": "The person slowly turns and smiles",
  "image_urls": ["https://upload.gccai.ai/f/models/9998230426123070-e9d6af04-cb5e-4731-8ae7-abf144cb0d29-9998230586368386-29641169-f698-4ab9-9b6d-380899e6521e-9998230593110693-c1741a3a-.webp"],
  "mode": "std",
  "duration": 5
}
```

> Le système ajoute automatiquement `<<<image_1>>>` au début du prompt, ce qui équivaut à `"<<<image_1>>>The person slowly turns and smiles"`.

### Cas 5 : Générer une vidéo avec audio

```json theme={null}
{
  "model": "kling-v3-omni",
  "prompt": "A yellow canary singing on a branch",
  "audio": true,
  "mode": "std",
  "duration": 5
}
```

> **Note** : `audio` est mutuellement exclusif avec `video_list`. Lorsque `video_list` a une valeur, le paramètre `audio` n'est pas nécessaire.

> [!NOTE]
>
> **Interroger les résultats de la tâche**
>
> La génération vidéo est une tâche asynchrone qui renvoie un `task_id` lors de la soumission. Utilisez le point de terminaison [Obtenir le statut de la tâche](https://gccai.heqingsong.uk/fr/api-reference/tasks/status.md) pour interroger la progression et les résultats.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.