> ## 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.

# Geração de vídeo Kling v3 Omni

>  - Modo de processamento assíncrono, retorna um ID de tarefa para consultas posteriores
- Interface unificada text-to-video/image-to-video com sintaxe de referência de imagens
- Suporta modo padrão (720P), modo profissional (1080P) e modo 4K
- Referencie imagens nos prompts usando a sintaxe image_N
- Suporta a geração de vídeos com áudio (mutuamente exclusivo com 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"
  }
}
```

## Autorização

**Authorization** `string` *required*

Todos os endpoints da API exigem autenticação via Bearer Token

Obtenha sua chave de API:

Acesse a [página de gerenciamento de chaves de API](https://gccai.heqingsong.uk/keys) para obter sua chave de API

Adicione-a ao cabeçalho da requisição:

```
Authorization: Bearer YOUR_API_KEY
```

## Parâmetros da requisição

**model** `string` *required*

Nome do modelo de geração de vídeo

Modelos suportados:

* `kling-v3-omni` - Kling v3 Omni (interface unificada)

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

Define se o conteúdo deve ser moderado antes do envio da tarefa de vídeo.

* `true`: verificar prompts e imagens de entrada com `omni-moderation-latest`
* `false` ou omitido: não enviar solicitação de moderação, sem custo nem latência adicionais de moderação (padrão)

**prompt** `string` *required*

Prompt de texto positivo

Suporta referência a imagens de `image_urls` usando a sintaxe `<<<image_N>>>`, onde `N` começa em 1.

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

> [!NOTE]
>
> Se imagens forem fornecidas, mas o prompt não contiver nenhuma referência `<<<image_N>>>`, o sistema adicionará automaticamente `<<<image_1>>>` no início do prompt.

**negative\_prompt** `string`

Prompt negativo usado para excluir conteúdo indesejado. Comprimento máximo de 2500 caracteres.

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

Modo de geração

Opções:

* `std` - Modo padrão (720P)
* `pro` - Modo profissional (1080P)
* `4k` - Modo 4K ultra HD

Padrão: `std`

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

Padrão: `5`
Duração do vídeo (segundos)

Faixa: 3-15 (mínimo de 3 segundos, máximo de 15 segundos)

**⚠️ Nota:** Deve ser um número simples (por exemplo, `6`), sem aspas, caso contrário ocorrerá um erro

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

Proporção do vídeo

Opções:

* `16:9` - Paisagem
* `9:16` - Retrato
* `1:1` - Quadrado

Padrão: `16:9`

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

Array de URLs de imagens para referenciamento de imagens

Referencie as imagens correspondentes no prompt usando a sintaxe `<<<image_N>>>` (N começa em 1)

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

> [!WARNING]
>
> * As URLs das imagens devem ser publicamente acessíveis, sem proteção contra hotlink
> * No modo image-to-video, `aspect_ratio` pode ser substituído pela proporção real da imagem

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

Array de imagens baseado em papéis, recomendado para image-to-video.

Formato de cada item: `{ "url": "...", "role": "..." }`

* `first_frame`: primeiro frame
* `last_frame`: último frame
* `reference`: imagem de referência

> [!WARNING]
>
> `image_urls` e `image_with_roles` são mutuamente exclusivos. Use apenas um.

**video\_list** `array`

Lista de vídeos de referência (baseada em URLs), até 1 vídeo.

Use `refer_type` para distinguir os tipos:

* `base`: vídeo a ser editado (padrão)
* `feature`: vídeo de referência por característica

Use `keep_original_sound` para controlar o áudio original:

* `no`: não manter (padrão)
* `yes`: manter o áudio original

Formato da requisição:

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

> [!WARNING]
>
> * `video_url` não pode estar vazio, e a URL do vídeo deve ser acessível
> * Quando `refer_type=base`:
>   * Não é possível definir frames inicial/final
>   * O vídeo de referência deve ter de 3 a 10 segundos
>   * A duração do vídeo gerado segue o vídeo enviado
> * Quando `refer_type=feature` e `video_url` não está vazio:
>   * `image_urls` só pode incluir uma imagem de primeiro frame
> * Requisitos do vídeo: apenas MP4/MOV; duração de pelo menos 3 segundos; resolução de 720px-2160px; taxa de quadros de 24-60fps (a saída é 24fps); tamanho não superior a 200MB

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

Define se o modo multi-shot (múltiplos planos) deve ser ativado.

**shot\_type** `string`

Método de divisão de planos: `customize` / `intelligence`.

Obrigatório quando `multi_shot=true`.

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

Lista multi-shot, cada item é `{ index, prompt, duration }`.

* Mínimo 1 plano, máximo 6 planos
* Cada `duration` de plano deve ser um inteiro e >= 1
* A soma das durações de todos os planos deve ser igual ao `duration` de nível superior
* `index` deve começar em 1 e aumentar continuamente
* Obrigatório quando `multi_shot=true` e `shot_type=customize`

Exemplo:

```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\>`

Lista de sujeitos de referência, até 3 sujeitos. Suporta:

* Criar sujeitos na hora com `name`, `description`, `element_input_urls`

Formato comum:

```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"
    ]
  }
]
```

Observações:

* Para criação na hora, `name`, `description`, `element_input_urls` são obrigatórios
* `element_input_urls`: 2 a 4 imagens por sujeito (a primeira como imagem frontal, as demais como referências)
* Use `@name` em `prompt`, por exemplo, `"@element_dog and @element_cat are playing on the grass"`

**watermark** `boolean`

Define se uma marca d'água deve ser adicionada

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

Define se o vídeo deve ser gerado com áudio

> [!WARNING]
>
> Este parâmetro é mutuamente exclusivo com `video_list`.
>
> Quando `video_list` tem um valor, o parâmetro `audio` não é necessário.

### Restrições e limites de parâmetros

* `image_urls` e `image_with_roles` são mutuamente exclusivos
* `mode=4k` está disponível para `kling-v3-omni`
* Entrada apenas do último frame (`last_frame` sem o primeiro frame) é inválida
* Frames inicial/final e edição de vídeo são mutuamente exclusivos: quando `video_list.refer_type=base` (ou omitido), frames inicial/final não são permitidos
* Quando `video_list` está presente, `audio` é ignorado
* `video_list` suporta no máximo 1 vídeo
* `multi_prompt` suporta até 6 planos, com `index` começando em 1 e aumentando continuamente

## Sintaxe de referência de imagens

O modelo Omni usa a sintaxe `<<<image_N>>>` para referenciar imagens nos prompts, oferecendo uma experiência unificada de text-to-video/image-to-video:

| Sintaxe | Descrição |
| - | - |
| `<<<image_1>>>` | Referencia a 1ª imagem no array `image_urls` |
| `<<<image_2>>>` | Referencia a 2ª imagem no array `image_urls` |

> [!NOTE]
>
> **Referência automática**: Se `image_urls` for fornecido, mas o prompt não contiver nenhuma referência `<<<image_N>>>`, o sistema adicionará automaticamente `<<<image_1>>>` no início do prompt.

## Resposta

**code** `integer`

Código de status da resposta, 200 em caso de sucesso

**data** `array`

Array de dados da resposta

**Elementos do array**

**status** `string`

Status da tarefa, `submitted` na submissão inicial

**task\_id** `string`

Identificador único da tarefa para consultar status e resultados

## Casos de uso

### Caso 1: Texto para vídeo (Modo padrão)

```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"
}
```

### Caso 2: Referência de imagem (uma imagem)

```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
}
```

### Caso 3: Múltiplas referências de imagens

```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
}
```

### Caso 4: Imagem fornecida sem referência explícita (adicionada automaticamente)

```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
}
```

> O sistema adicionará automaticamente `<<<image_1>>>` no início do prompt, equivalente a `"<<<image_1>>>The person slowly turns and smiles"`.

### Caso 5: Gerar vídeo com áudio

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

> **Nota**: `audio` é mutuamente exclusivo com `video_list`. Quando `video_list` tem um valor, o parâmetro `audio` não é necessário.

> [!NOTE]
>
> **Consultar os resultados da tarefa**
>
> A geração de vídeo é uma tarefa assíncrona que retorna um `task_id` ao ser submetida. Use o endpoint [Obter status da tarefa](https://gccai.heqingsong.uk/pt/api-reference/tasks/status.md) para consultar o progresso e os resultados da geração.


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