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

# Vidu Q3 (mix/standard) Reference-to-Video

>  - Modo de processamento assíncrono, retorna um ID de tarefa para consultas posteriores
- Envie de 1 a 7 imagens de referência + um prompt de texto para gerar vídeos curtos contendo os sujeitos de referência
- Suporta resoluções 540p / 720p / 1080p
- Faixa de duração de 1 a 16 segundos, adequado para consistência de personagens e continuidade de estilo 

```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": "viduq3",
    "prompt": "Santa Claus and the bear hug by the lakeside",
    "image_urls": [
      "https://example.com/santa.png",
      "https://example.com/bear.png"
    ],
    "duration": 8,
    "resolution": "720p",
    "aspect_ratio": "16:9"
  }'
```

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

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

payload = {
    "model": "viduq3",
    "prompt": "Santa Claus and the bear hug by the lakeside",
    "image_urls": [
        "https://example.com/santa.png",
        "https://example.com/bear.png"
    ],
    "duration": 8,
    "resolution": "720p",
    "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: "viduq3",
  prompt: "Santa Claus and the bear hug by the lakeside",
  image_urls: [
    "https://example.com/santa.png",
    "https://example.com/bear.png"
  ],
  duration: 8,
  resolution: "720p",
  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":        "viduq3",
        "prompt":       "Santa Claus and the bear hug by the lakeside",
        "image_urls":   []string{"https://example.com/santa.png", "https://example.com/bear.png"},
        "duration":     8,
        "resolution":   "720p",
        "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": "viduq3",
          "prompt": "Santa Claus and the bear hug by the lakeside",
          "image_urls": [
            "https://example.com/santa.png",
            "https://example.com/bear.png"
          ],
          "duration": 8,
          "resolution": "720p",
          "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" => "viduq3",
    "prompt" => "Santa Claus and the bear hug by the lakeside",
    "image_urls" => [
        "https://example.com/santa.png",
        "https://example.com/bear.png"
    ],
    "duration" => 8,
    "resolution" => "720p",
    "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: "viduq3",
  prompt: "Santa Claus and the bear hug by the lakeside",
  image_urls: [
    "https://example.com/santa.png",
    "https://example.com/bear.png"
  ],
  duration: 8,
  resolution: "720p",
  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": "viduq3",
    "prompt": "Santa Claus and the bear hug by the lakeside",
    "image_urls": [
        "https://example.com/santa.png",
        "https://example.com/bear.png"
    ],
    "duration": 8,
    "resolution": "720p",
    "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"": ""viduq3"",
            ""prompt"": ""Santa Claus and the bear hug by the lakeside"",
            ""image_urls"": [
                ""https://example.com/santa.png"",
                ""https://example.com/bear.png""
            ],
            ""duration"": 8,
            ""resolution"": ""720p"",
            ""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:

* `viduq3-mix` - Qualidade premium, transições inteligentes mais robustas, suporta vídeos curtos de 1 segundo
* `viduq3` - Escolha padrão, com troca de câmera mais inteligente

> [!NOTE]
>
> **Como escolher**: Use `viduq3` para uso cotidiano; use `viduq3-mix` para qualidade premium ou efeitos de movimento de 1-2 segundos.

**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, máximo de **5000 caracteres**

Descreva ações e movimentos de câmera, não a aparência (a aparência é determinada pelas imagens de referência).

Exemplo: `"Santa Claus and the bear hug by the lakeside"`

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

Array de URLs de imagens de referência, **1 a 7 imagens**

Suporta URLs de imagens publicamente acessíveis (http\:// ou https\://)

Exemplo: `["https://example.com/santa.png", "https://example.com/bear.png"]`

> [!WARNING]
>
> * Quantidade: **1 a 7 imagens**
> * Formatos suportados: PNG, JPEG, JPG, WebP
> * Tamanho mínimo: 128×128
> * Proporção: entre 1:4 e 4:1
> * Tamanho máximo de arquivo: ≤ 50MB por imagem
> * Devem ser URLs publicamente acessíveis

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

Duração do vídeo (segundos)

* `viduq3-mix`: `1` a `16`
* `viduq3`: `3` a `16`

Padrão: `5`

> [!WARNING]
>
> `viduq3` suporta o mínimo de 3 segundos, `viduq3-mix` suporta o mínimo de 1 segundo. Por favor, passe uma duração válida de acordo com o modelo selecionado.

**resolution** `string` (default: 720p)

Resolução do vídeo

* `viduq3-mix`: `720p` (padrão) / `1080p`
* `viduq3`: `540p` / `720p` (padrão) / `1080p`

> [!WARNING]
>
> `viduq3-mix` não suporta `540p`, use `720p` ou `1080p`.

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

Proporção do vídeo

Opções:

* `16:9` - Paisagem (padrão)
* `9:16` - Retrato
* `4:3` - Tradicional
* `3:4` - Tradicional vertical
* `1:1` - Quadrado

**seed** `integer`

Seed aleatório para controlar a aleatoriedade da geração

Se não for fornecido, será usado um seed aleatório.

> [!NOTE]
>
> Usar o mesmo seed com parâmetros idênticos produzirá resultados semelhantes, mas não é garantido que sejam exatamente iguais.

## Comparação de modelos

| Recurso | `viduq3` | `viduq3-mix` |
| - | - | - |
| Recomendado para | Uso cotidiano, troca de câmera em múltiplos ângulos | Qualidade premium, efeitos de movimento de 1-2 segundos |
| Faixa de duração | 3-16 segundos | 1-16 segundos |
| Resolução | 540p / 720p / 1080p | 720p / 1080p |
| Imagens de referência | 1-7 imagens | 1-7 imagens |

## 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: viduq3 Reference-to-Video básico

```json theme={null}
{
  "model": "viduq3",
  "prompt": "Santa Claus and the bear hug by the lakeside",
  "image_urls": [
    "https://example.com/santa.png",
    "https://example.com/bear.png"
  ]
}
```

### Caso 2: viduq3-mix Reference-to-Video de alta qualidade

```json theme={null}
{
  "model": "viduq3-mix",
  "prompt": "A cyberpunk neon street with the cat from reference image walking by",
  "image_urls": [
    "https://example.com/cat-1.png",
    "https://example.com/cat-2.png",
    "https://example.com/cat-3.png"
  ],
  "duration": 8,
  "resolution": "1080p",
  "aspect_ratio": "16:9",
  "seed": 42
}
```

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