> ## 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) 参考生视频

>  - 异步处理模式，返回任务ID用于后续查询
- 上传 1-7 张参考图 + 文字提示词，生成包含参考主体的短视频
- 支持 540p / 720p / 1080p 分辨率
- 时长范围 1-16 秒，适用于角色一致性、风格延续等场景 

```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": "圣诞老人与熊在湖边相拥",
    "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": "圣诞老人与熊在湖边相拥",
    "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: "圣诞老人与熊在湖边相拥",
  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":       "圣诞老人与熊在湖边相拥",
        "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": "圣诞老人与熊在湖边相拥",
          "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" => "圣诞老人与熊在湖边相拥",
    "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: "圣诞老人与熊在湖边相拥",
  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": "圣诞老人与熊在湖边相拥",
    "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"": ""圣诞老人与熊在湖边相拥"",
            ""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": "请求参数无效",
    "type": "invalid_request_error"
  }
}
```

```json 401 theme={null}
{
  "error": {
    "code": 401,
    "message": "身份验证失败，请检查您的API密钥",
    "type": "authentication_error"
  }
}
```

```json 402 theme={null}
{
  "error": {
    "code": 402,
    "message": "账户余额不足，请充值后再试",
    "type": "payment_required"
  }
}
```

```json 429 theme={null}
{
  "error": {
    "code": 429,
    "message": "请求过于频繁，请稍后再试",
    "type": "rate_limit_error"
  }
}
```

```json 500 theme={null}
{
  "error": {
    "code": 500,
    "message": "服务器内部错误，请稍后重试",
    "type": "server_error"
  }
}
```

## 认证

**Authorization** `string` *required*

所有接口均需要使用 Bearer Token 进行认证

获取 API Key：

访问 [API Key 管理页面](https://apimart.ai/keys) 获取您的 API Key

使用时在请求头中添加：

```
Authorization: Bearer YOUR_API_KEY
```

## 请求参数

**model** `string` *required*

视频生成模型名称

支持的模型：

* `viduq3-mix` - 综合画质王，智能转场更强，支持 1 秒短视频
* `viduq3` - 默认首选，镜头切换更聪明

> [!NOTE]
>
> **如何选择**：日常用 `viduq3`；要冲画质或要做 1-2 秒动效就用 `viduq3-mix`。

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

是否在提交视频任务前执行内容审核。

* `true`：使用 `omni-moderation-latest` 审核提示词和输入图片
* `false` 或不传：不发起审核请求，不增加审核成本与延迟（默认）

**prompt** `string` *required*

文本提示词，最长 **5000 个字符**

描述动作和镜头，不要描述外观（外观由参考图片决定）。

示例：`"圣诞老人与熊在湖边相拥"`

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

参考图片 URL 数组，**1-7 张**

支持公网可访问的图片 URL（http\:// 或 https\://）

示例：`["https://example.com/santa.png", "https://example.com/bear.png"]`

> [!WARNING]
>
> * 数量：**1-7 张**
> * 支持格式：PNG、JPEG、JPG、WebP
> * 最小尺寸：128×128
> * 宽高比：1:4 \~ 4:1 之间
> * 单张大小：≤ 50MB
> * 必须是公网可访问的 URL

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

视频时长（秒）

* `viduq3-mix`：`1` 到 `16`
* `viduq3`：`3` 到 `16`

默认值：`5`

> [!WARNING]
>
> `viduq3` 最低支持 3 秒，`viduq3-mix` 最低支持 1 秒。请根据所选模型传入有效时长。

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

视频分辨率

* `viduq3-mix`：`720p`（默认）/ `1080p`
* `viduq3`：`540p` / `720p`（默认）/ `1080p`

> [!WARNING]
>
> `viduq3-mix` 不支持 `540p`，请使用 `720p` 或 `1080p`。

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

视频宽高比

可选值：

* `16:9` - 横屏（默认）
* `9:16` - 竖屏
* `4:3` - 传统比例
* `3:4` - 竖版传统比例
* `1:1` - 方形

**seed** `integer`

随机种子，用于控制生成内容的随机性

不传则随机生成。

> [!NOTE]
>
> 相同参数下使用相同 seed 值会生成类似的结果，但不保证完全一致。

## 模型对比

| 特性 | `viduq3` | `viduq3-mix` |
| - | - | - |
| 推荐场景 | 日常使用、多机位镜头切换 | 冲画质、1-2 秒动效 |
| 时长范围 | 3-16 秒 | 1-16 秒 |
| 分辨率 | 540p / 720p / 1080p | 720p / 1080p |
| 参考图数量 | 1-7 张 | 1-7 张 |

## 响应

**code** `integer`

响应状态码，成功时为 200

**data** `array`

返回数据数组

**数组元素**

**status** `string`

任务状态，初始提交时为 `submitted`

**task\_id** `string`

任务唯一标识符，用于查询任务状态和结果

## 使用场景

### 场景 1：viduq3 基础参考生视频

```json theme={null}
{
  "model": "viduq3",
  "prompt": "圣诞老人与熊在湖边相拥",
  "image_urls": [
    "https://example.com/santa.png",
    "https://example.com/bear.png"
  ]
}
```

### 场景 2：viduq3-mix 高画质参考生视频

```json theme={null}
{
  "model": "viduq3-mix",
  "prompt": "参考图中的猫走过赛博朋克霓虹街道",
  "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]
>
> **查询任务结果**
>
> 视频生成为异步任务，提交后会返回 `task_id`。使用 [获取任务状态](https://docs.apimart.ai/cn/api-reference/tasks/status.md) 接口查询生成进度和结果。


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