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

>  - Modo de processamento assíncrono, retorna um ID de tarefa para consultas posteriores
- Suporta text-to-video e image-to-video (controle de primeiro frame / primeiro e último frames)
- Suporta modo padrão (720P), modo profissional (1080P) e modo 4K
- Suporta durações de vídeo de 3 a 15 segundos
- Suporta a geração de vídeos com áudio 

```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",
    "prompt": "A golden cat running on a sunlit meadow, slow motion, cinematic quality",
    "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",
    "prompt": "A golden cat running on a sunlit meadow, slow motion, cinematic quality",
    "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",
  prompt: "A golden cat running on a sunlit meadow, slow motion, cinematic quality",
  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",
        "prompt":       "A golden cat running on a sunlit meadow, slow motion, cinematic quality",
        "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",
          "prompt": "A golden cat running on a sunlit meadow, slow motion, cinematic quality",
          "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",
    "prompt" => "A golden cat running on a sunlit meadow, slow motion, cinematic quality",
    "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",
  prompt: "A golden cat running on a sunlit meadow, slow motion, cinematic quality",
  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",
    "prompt": "A golden cat running on a sunlit meadow, slow motion, cinematic quality",
    "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"",
            ""prompt"": ""A golden cat running on a sunlit meadow, slow motion, cinematic quality"",
            ""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` - Kling v3 (recomendado)

**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

Descreva cenas, ações e estilos em detalhes para obter melhores resultados. Recomenda-se utilizar prompts em inglês.

Exemplo: `"a golden retriever running on the beach, sunset, cinematic"`

**negative\_prompt** `string`

Prompt negativo para excluir conteúdo indesejado

Exemplo: `"blurry, low quality, distorted"`

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

Modo de geração

Opções:

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

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

Ao usar `element_list`, é obrigatório fornecer pelo menos 1 imagem por meio de `image_urls`.

Array de URLs de imagens para geração image-to-video

* Forneça **1 imagem**: usada como primeiro frame
* Forneça **2 imagens**: atribuídas automaticamente como primeiro frame + último frame

Suporta no máximo 2 imagens

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

> [!WARNING]
>
> * Suporta no máximo 2 imagens
> * 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

**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

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

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

* `true`
* `false`

**shot\_type** `string`

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

Obrigatório quando `multi_shot=true`.

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

Informações por plano, como prompt e duração.

Defina a ordem, o prompt e a duração dos planos por meio de `index`, `prompt` e `duration`.

* Suporta de 1 a 6 planos
* O comprimento máximo do conteúdo por plano é 512
* A duração de cada plano deve ser >= 1 e não pode exceder a duração total da tarefa
* A soma das durações de todos os planos deve ser igual ao `duration` de nível superior

Formato:

```json theme={null}
"multi_prompt": [
  { "index": 1, "prompt": "string", "duration": 5 },
  { "index": 2, "prompt": "string", "duration": 5 }
]
```

Obrigatório quando `multi_shot=true` e `shot_type=customize`.

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

Ao usar `element_list`, é obrigatório fornecer pelo menos 1 imagem por meio de `image_urls`.

> [!WARNING]
>
> Se nenhuma imagem for fornecida em `image_urls`, as informações dos elementos em `element_list` poderão não ser aplicadas. `element_input_urls` define as imagens de referência dos sujeitos e não substitui `image_urls`.

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

* Criados na hora via `name`, `description`, `element_input_urls`

Exemplo:

```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` e `element_input_urls` são obrigatórios
* `element_input_urls`: 2-4 imagens por sujeito (a primeira como imagem frontal, as demais como referências)
* Referencie os elementos em `prompt` com `@name`, por exemplo, `"@element_dog chasing @element_cat on grass"`

### Restrições de parâmetros

* `mode=4k` é suportado para `kling-v3`
* `image_urls` suporta até 2 imagens (1 primeiro frame, 2 primeiro+último frames)
* Ao usar `element_list`, é obrigatório fornecer pelo menos 1 imagem por meio de `image_urls`.
* Entrada apenas do último frame é inválida (deve incluir o primeiro frame)
* Quando `multi_shot=true`, o `prompt` de nível superior pode ser omitido
* `multi_prompt` suporta até 6 planos, e `index` deve começar em 1 e ser contínuo

## Matriz de suporte de recursos

| Tipo | Recurso | std 5s | std 10s | std 15s | pro 5s | pro 10s |
| - | - | - | - | - | - | - |
| Text-to-Video | Geração | ✅ | ✅ | ✅ | ✅ | ✅ |
| Image-to-Video | Geração | ✅ | ✅ | ✅ | ✅ | ✅ |
| Image-to-Video | Primeiro frame | ✅ | ✅ | ✅ | ✅ | ✅ |
| Image-to-Video | Último frame | ✅ | ✅ | ✅ | ✅ | ✅ |

## Texto para vídeo (Text-to-Video) vs Imagem para vídeo (Image-to-Video)

O sistema determina automaticamente o modo com base no fato de `image_urls` ser fornecido ou não: sem imagens significa text-to-video, com imagens significa image-to-video.

| Parâmetro | Text-to-Video | Image-to-Video |
| - | - | - |
| `prompt` | ✅ Obrigatório | ✅ Obrigatório |
| `image_urls` | ❌ Não utilizado | ✅ Obrigatório (1-2 imagens) |
| `negative_prompt` | ✅ Opcional | ✅ Opcional |
| `mode` | ✅ Opcional | ✅ Opcional |
| `duration` | ✅ Opcional (3-15) | ✅ Opcional (3-15) |
| `aspect_ratio` | ✅ Opcional | ⚠️ Pode ser substituído pela proporção da imagem |
| `watermark` | ✅ Opcional | ✅ Opcional |
| `audio` | ✅ Opcional | ✅ Opcional |

## 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",
  "prompt": "A golden cat running on a sunlit meadow, slow motion, cinematic quality",
  "mode": "std",
  "duration": 5,
  "aspect_ratio": "16:9"
}
```

### Caso 2: Texto para vídeo (Modo Pro + prompt negativo)

```json theme={null}
{
  "model": "kling-v3",
  "prompt": "Tokyo Shibuya crossing at night, neon lights reflected on wet ground, people walking with umbrellas",
  "negative_prompt": "blurry, low quality, distorted",
  "mode": "pro",
  "duration": 10,
  "aspect_ratio": "16:9"
}
```

### Caso 3: Texto para vídeo (15 segundos)

```json theme={null}
{
  "model": "kling-v3",
  "prompt": "a time-lapse of a flower blooming in a garden",
  "duration": 15,
  "aspect_ratio": "16:9"
}
```

### Caso 4: Imagem para vídeo (Primeiro frame)

```json theme={null}
{
  "model": "kling-v3",
  "prompt": "the cat slowly walks forward and looks around",
  "image_urls": ["https://example.com/cat.jpg"],
  "mode": "std",
  "duration": 5
}
```

### Caso 5: Imagem para vídeo (Controle de primeiro + último frame)

```json theme={null}
{
  "model": "kling-v3",
  "prompt": "smooth cinematic transition",
  "image_urls": [
    "https://example.com/frame-start.jpg",
    "https://example.com/frame-end.jpg"
  ],
  "mode": "std",
  "duration": 5
}
```

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

```json theme={null}
{
  "model": "kling-v3",
  "prompt": "A rock singer singing on this stage, concert scene, flashing lights",
  "audio": true,
  "mode": "std",
  "duration": 5
}
```

### Caso 7: Storyboard multi-shot (`customize`, 15 segundos, vertical com áudio)

```json theme={null}
{
  "model": "kling-v3",
  "multi_prompt": [
    {
      "index": 1,
      "prompt": "Two friends talking under a streetlight at night. Warm glow, casual poses, no dialogue.",
      "duration": 2
    },
    {
      "index": 2,
      "prompt": "A runner sprinting through a forest, leaves flying. Low-angle shot, focus on movement.",
      "duration": 3
    },
    {
      "index": 3,
      "prompt": "A woman hugging a cat, smiling. Soft sunlight, cozy home setting, emphasize warmth.",
      "duration": 3
    },
    {
      "index": 4,
      "prompt": "A door creaking open, shadowy hallway. Dark tones, minimal details, eerie mood.",
      "duration": 3
    },
    {
      "index": 5,
      "prompt": "A man slipping on a banana peel, shocked expression. Exaggerated pose, bright colors.",
      "duration": 3
    },
    {
      "index": 6,
      "prompt": "A sunset over mountains, small figure walking away. Wide angle, peaceful atmosphere.",
      "duration": 1
    }
  ],
  "multi_shot": true,
  "shot_type": "customize",
  "duration": 15,
  "mode": "pro",
  "audio": true,
  "aspect_ratio": "9:16"
}
```

> [!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.