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

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

>  - Async processing mode, returns task ID for subsequent queries
- Upload 1-7 reference images + text prompt to generate short videos containing reference subjects
- Supports 540p / 720p / 1080p resolution
- Duration range 1-16 seconds, suitable for character consistency and style continuation 

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url https://api.apimart.ai/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://api.apimart.ai/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://api.apimart.ai/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://api.apimart.ai/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://api.apimart.ai/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://api.apimart.ai/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://api.apimart.ai/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://api.apimart.ai/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://api.apimart.ai/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);
      }
  }
  ```
</RequestExample>

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

## Authorization

<ParamField header="Authorization" type="string" required>
  All API endpoints require Bearer Token authentication

  Get your API Key:

  Visit the [API Key Management Page](https://apimart.ai/keys) to get your API Key

  Add it to the request header:

  ```
  Authorization: Bearer YOUR_API_KEY
  ```
</ParamField>

## Request Parameters

<ParamField body="model" type="string" required>
  Video generation model name

  Supported models:

  * `viduq3-mix` - Premium quality, stronger smart transitions, supports 1-second short videos
  * `viduq3` - Default choice, smarter camera switching

  <Note>
    **How to choose**: Use `viduq3` for everyday use; use `viduq3-mix` for premium quality or 1-2 second motion effects.
  </Note>
</ParamField>

<ParamField body="prompt" type="string" required>
  Text prompt, maximum **5000 characters**

  Describe actions and camera movements, not appearance (appearance is determined by reference images).

  Example: `"Santa Claus and the bear hug by the lakeside"`
</ParamField>

<ParamField body="image_urls" type="array<url>" required>
  Reference image URL array, **1-7 images**

  Supports publicly accessible image URLs (http\:// or https\://)

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

  <Warning>
    * Quantity: **1-7 images**
    * Supported formats: PNG, JPEG, JPG, WebP
    * Minimum size: 128×128
    * Aspect ratio: between 1:4 and 4:1
    * Maximum file size: ≤ 50MB per image
    * Must be publicly accessible URLs
  </Warning>
</ParamField>

<ParamField body="duration" type="integer" default="5">
  Video duration (seconds)

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

  Default: `5`

  <Warning>
    `viduq3` supports minimum 3 seconds, `viduq3-mix` supports minimum 1 second. Please pass a valid duration based on the selected model.
  </Warning>
</ParamField>

<ParamField body="resolution" type="string" default="720p">
  Video resolution

  * `viduq3-mix`: `720p` (default) / `1080p`
  * `viduq3`: `540p` / `720p` (default) / `1080p`

  <Warning>
    `viduq3-mix` does not support `540p`, please use `720p` or `1080p`.
  </Warning>
</ParamField>

<ParamField body="aspect_ratio" type="string" default="16:9">
  Video aspect ratio

  Options:

  * `16:9` - Landscape (default)
  * `9:16` - Portrait
  * `4:3` - Traditional
  * `3:4` - Portrait traditional
  * `1:1` - Square
</ParamField>

<ParamField body="seed" type="integer">
  Random seed for controlling generation randomness

  If not provided, a random seed will be used.

  <Note>
    Using the same seed with identical parameters will produce similar results, but not guaranteed to be exactly the same.
  </Note>
</ParamField>

## Model Comparison

| Feature          | `viduq3`                                   | `viduq3-mix`                               |
| ---------------- | ------------------------------------------ | ------------------------------------------ |
| Recommended for  | Everyday use, multi-angle camera switching | Premium quality, 1-2 second motion effects |
| Duration range   | 3-16 seconds                               | 1-16 seconds                               |
| Resolution       | 540p / 720p / 1080p                        | 720p / 1080p                               |
| Reference images | 1-7 images                                 | 1-7 images                                 |

## Response

<ResponseField name="code" type="integer">
  Response status code, 200 on success
</ResponseField>

<ResponseField name="data" type="array">
  Response data array

  <Expandable title="Array Elements">
    <ResponseField name="status" type="string">
      Task status, `submitted` when initially submitted
    </ResponseField>

    <ResponseField name="task_id" type="string">
      Unique task identifier for querying task status and results
    </ResponseField>
  </Expandable>
</ResponseField>

## Use Cases

### Case 1: viduq3 Basic Reference-to-Video

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

### Case 2: viduq3-mix High Quality Reference-to-Video

```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>
  **Query Task Results**

  Video generation is an async task that returns a `task_id` upon submission. Use the [Get Task Status](/en/api-reference/tasks/status) endpoint to query generation progress and results.
</Note>