> ## 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(pro/turbo) Video Generation

>  - Async processing mode, returns task ID for subsequent queries
- Supports text-to-video, image-to-video, first-last frame video generation
- Supports 540p / 720p / 1080p resolution
- Duration range 1-16 seconds, audio enabled by default 

<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-pro",
      "prompt": "A cat playing piano, camera slowly zooms in",
      "duration": 8,
      "resolution": "1080p",
      "aspect_ratio": "16:9"
    }'
  ```

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

  url = "https://api.apimart.ai/v1/videos/generations"

  payload = {
      "model": "viduq3-pro",
      "prompt": "A cat playing piano, camera slowly zooms in",
      "duration": 8,
      "resolution": "1080p",
      "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-pro",
    prompt: "A cat playing piano, camera slowly zooms in",
    duration: 8,
    resolution: "1080p",
    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-pro",
          "prompt":       "A cat playing piano, camera slowly zooms in",
          "duration":     8,
          "resolution":   "1080p",
          "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-pro",
            "prompt": "A cat playing piano, camera slowly zooms in",
            "duration": 8,
            "resolution": "1080p",
            "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-pro",
      "prompt" => "A cat playing piano, camera slowly zooms in",
      "duration" => 8,
      "resolution" => "1080p",
      "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-pro",
    prompt: "A cat playing piano, camera slowly zooms in",
    duration: 8,
    resolution: "1080p",
    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-pro",
      "prompt": "A cat playing piano, camera slowly zooms in",
      "duration": 8,
      "resolution": "1080p",
      "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-pro"",
              ""prompt"": ""A cat playing piano, camera slowly zooms in"",
              ""duration"": 8,
              ""resolution"": ""1080p"",
              ""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-pro` - Vidu Q3 Pro
  * `viduq3-turbo` - Vidu Q3 Turbo
</ParamField>

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

  Required for text-to-video. Optional for image-to-video and first-last frame modes.

  Example: `"A cat playing piano, camera slowly zooms in"`
</ParamField>

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

  Range: `1` to `16`

  Default: `5`
</ParamField>

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

  Options:

  * `540p` - Standard definition
  * `720p` - HD (default)
  * `1080p` - Full HD

  Default: `720p`
</ParamField>

<ParamField body="aspect_ratio" type="string">
  Video aspect ratio (only for text-to-video mode)

  Options:

  * `16:9` - Landscape
  * `9:16` - Portrait
  * `4:3` - Traditional
  * `3:4` - Portrait traditional
  * `1:1` - Square

  <Warning>
    This parameter is only available in text-to-video mode (when `image_urls` is not provided).
  </Warning>
</ParamField>

<ParamField body="image_urls" type="array<url>">
  Image URL array for image-to-video generation

  The system automatically determines the generation mode based on the number of images:

  * **0 images** (not provided): Text-to-video mode
  * **1 image**: Image-to-video mode (image used as starting frame)
  * **2 images**: First-last frame mode (first image = first frame, second image = last frame)

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

  <Warning>
    * Maximum 2 images supported
    * For first-last frame mode, exactly 2 images must be provided
    * When `image_urls` is provided (whether 1 or 2 images), the `aspect_ratio` parameter cannot be used — the video aspect ratio will be automatically determined by the image
  </Warning>
</ParamField>

<ParamField body="audio" type="boolean" default="true">
  Whether to generate audio (dialogue, sound effects)

  Default: `true`

  Set to `false` if you need a silent video.
</ParamField>

<ParamField body="seed" type="integer">
  Seed integer used to control randomness in generated content

  Range: integer between `-1` and `2^32-1`

  <Note>
    * With the same request, different seed values (including unspecified or `-1`, which uses a random number instead) will produce different results
    * With the same request, the same seed value will produce similar results, but exact reproducibility is not guaranteed
  </Note>
</ParamField>

## Auto Routing

The system automatically determines the generation mode based on the number of images in `image_urls`:

| Images Count     | Mode             | Description                                          |
| ---------------- | ---------------- | ---------------------------------------------------- |
| 0 (not provided) | Text-to-Video    | Generate from text description only                  |
| 1                | Image-to-Video   | Use the image as starting frame                      |
| 2                | First-Last Frame | First image = first frame, second image = last frame |

## Parameter Support Matrix

| Parameter      | Text-to-Video | Image-to-Video | First-Last Frame |
| -------------- | ------------- | -------------- | ---------------- |
| `model`        | ✅ Required    | ✅ Required     | ✅ Required       |
| `prompt`       | ✅ Required    | Optional       | Optional         |
| `image_urls`   | -             | ✅ 1 image      | ✅ 2 images       |
| `duration`     | ✅ 1-16s       | ✅ 1-16s        | ✅ 1-16s          |
| `resolution`   | ✅             | ✅              | ✅                |
| `aspect_ratio` | ✅             | -              | -                |
| `audio`        | ✅             | ✅              | ✅                |
| `seed`         | ✅             | ✅              | ✅                |

## 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: Text-to-Video

```json theme={null}
{
  "model": "viduq3-pro",
  "prompt": "A cat playing piano, camera slowly zooms in",
  "duration": 8,
  "resolution": "1080p",
  "aspect_ratio": "16:9"
}
```

### Case 2: Image-to-Video (Single Image)

```json theme={null}
{
  "model": "viduq3-pro",
  "prompt": "The person slowly turns and smiles",
  "image_urls": ["https://example.com/photo.jpg"],
  "duration": 5,
  "resolution": "720p"
}
```

### Case 3: First-Last Frame Video

```json theme={null}
{
  "model": "viduq3-pro",
  "prompt": "The person gradually sits down from standing",
  "image_urls": [
    "https://example.com/first.jpg",
    "https://example.com/last.jpg"
  ],
  "duration": 8
}
```

### Case 4: Silent Video (Audio Disabled)

```json theme={null}
{
  "model": "viduq3-pro",
  "prompt": "Sunset seascape timelapse photography",
  "duration": 10,
  "resolution": "1080p",
  "audio": false
}
```

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