API 协议
Vidu Q3 Ad:参数、场景与调用指南
预览指南
粘贴给 AI,帮助理解文档并完成接入。 仅包含文档与示例,不包含真实密钥。
直接答案本站入口为 JSON POST /v1/videos;使用本站 API Key,保存返回的 id,再以 GET /v1/videos/{id} 查询到 completed 或 failed。官方直连的 task_id、state 和鉴权格式不要混入本站请求。
更新 · 审核信息
模型定位与适用场景
Vidu Q3 Ad 支持图片参考。以下覆盖官方创建参数、模式限制及本站字段映射;标注“未开放”的参数仅供了解官方能力,不加入本站可执行示例。
本指南核对本站请求契约,不代表所有场景均已完成收费出片验收。使用模型广场显示的精确模型、分组和有效端点;示例中的 example.com 素材与占位任务 ID 必须替换。先以最小请求确认可用,再逐项添加参考素材和高级参数。价格以模型广场及实际账单为准。
型号与入口
viduq3-ad
POST /v1/videos
参考素材格式
| 素材 | 字段 | 传输格式 | 文件准备与限制 |
|---|---|---|---|
| 图片 | images | 公开 URL 或 data:image/<真实格式>;base64,...;JSON 数组,不能填本地路径。 | PNG/JPEG/JPG/WebP;整个请求体小于 20 MB(Base64 会增大体积)。Q3 参考图至少 128×128;数量限制见 images。Q3 页面画幅边界的表述有歧义,建议选择 1:4–4:1 范围内素材。 |
参数与组合限制
- 本站入口为 JSON POST /v1/videos;使用本站 API Key,保存返回的 id,再以 GET /v1/videos/{id} 查询到 completed 或 failed。官方直连的 task_id、state 和鉴权格式不要混入本站请求。
- 官方参数于 2026-11-17 按型号及模式核对;本站示例仅含已实现转发的参数,新增控制尚未通过真实出片验收。本站非 Mix 省略参数时为 5 秒、1080p,与部分官方默认值不同。 metadata.duration/resolution 会覆盖顶层参数;meta_data 是另一个官方字段。
- 官方创建响应包含 task_id、state;查询返回 err_code、payload、creations[].id/url/cover_url/watermarked_url 等。本站统一查询主要返回 status、video_url、metadata.url,不保证透传所有官方字段。官方生成物 URL 通常 24 小时有效,完成后及时下载;下载外部 URL 时不携带本站 Key。
- 官方部分参数表有相互矛盾的类型或默认值:已在相关行注明,不将文档歧义当作本站能力。尚未开放的字段可能被忽略或拒绝,不能通过塞进 metadata 来启用。本文不声称所有场景已经收费出片验收。
- 本型号官方创建表没有 audio 开关;不能通过 audio=false 承诺静音输出。
| 字段 | 类型 | 用法与限制 |
|---|---|---|
Authorization | header string | 必填。本站使用 Bearer <本站 API Key>,Content-Type: application/json。官方直连文档使用 Token <Vidu Key>,不要把两种凭证或鉴权格式混用。 |
model | string | 必填,固定为 viduq3-ad。 |
metadata.action | string | 本站模式选择:图片参考=referenceGenerate。建议始终显式填写。这是本站字段;官方使用不同创建端点选择模式。 |
prompt | string | 描述内容、动作、镜头和声音。官方文生及参考模式必填,图生/首尾帧可选;本站要求非空 prompt,图生且显式 is_rec=true 时可省略。最多 20000 字符。 |
images | string[] | 图片模式必填,本站传数组:图片参考 1–7 张;支持公开 URL 或带 MIME 前缀的 Base64 data URI,PNG/JPEG/JPG/WebP。 |
duration | integer | 官方 3–15 秒,默认 5 秒。本站使用顶层 duration,省略时默认 5 秒;metadata.duration 优先覆盖。也接受 seconds 别名;建议使用 duration。 |
resolution | string | 官方 720p/1080p,默认 720p。本站按 metadata.resolution > resolution > size 优先选择,省略时默认 1080p。本型号创建接口没有 540p,不能因价格页列出而发送。 |
seed | integer | 可选;官方省略或 0 都表示随机,非零值指定种子,文档未给出数值上下界。本站传 顶层 seed 或 metadata.seed,metadata 优先;显式 0 保留。相同种子不保证完全一致的输出。 |
payload | string | 可选透传文本,最多 1048576 字符,不是对象。本站传 payload 或 metadata.payload(metadata 优先)。官方任务/回调可返回该文本;本站统一查询不保证展示所有官方透传字段。 |
callback_url | string | 可选状态通知地址,本站传 callback_url 或 metadata.callback_url(metadata 优先)。Vidu 以 POST 通知 processing/success/failed,成功或失败通知发送失败会重试三次;回调体沿用官方任务查询结构,验签见官方回调签名文档。回调中的官方任务 ID 不等于本站 id;本站仍用 GET /v1/videos/{id} 查询。 |
aspect_ratio | string | 官方参考模式的画幅;1:1/16:9/9:16/3:4/4:3/auto(仅参考模式)。默认 16:9。参考模式的 auto 按素材推荐画幅。本站文生/参考模式可传顶层 aspect_ratio 或 metadata.aspect_ratio,默认 16:9。 |
watermark | boolean | 可选水印开关。官方多处标注默认 true,但同页文字又写“默认不加”,存在冲突,不能承诺统一默认值。官方通过 watermarked_url 提供带水印结果;本站统一查询没有承诺返回此字段。 |
wm_position | integer | 可选,默认 3;1 左上、2 右上、3 右下、4 左下,仅与水印输出一起使用。 |
wm_url | string | 可选水印图片 URL;省略时官方使用内置“内容由AI生成”标记,依赖水印开关。 |
meta_data | string (JSON) | 可选,必须为 JSON 编码字符串;用于产出标识,不是本站 metadata 对象。官方示例键包括 Label、ContentProducer、ContentPropagator、ProduceID、PropagateID、ReservedCode1、ReservedCode2,亦可自定义;省略时使用官方生成标识。 |
场景与代码示例
图片参考:最小请求
适用型号:viduq3-ad
POST /v1/videos
{
"model": "viduq3-ad",
"prompt": "镜头缓慢推进,保持主体外观一致。",
"duration": 3,
"size": "720p",
"metadata": {
"action": "referenceGenerate"
},
"images": [
"https://example.com/frame-1.png"
]
}
curl
curl --fail-with-body --silent --show-error --connect-timeout 10 --max-time 120 --request POST 'https://api.tu-zi.com/v1/videos' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"model": "viduq3-ad",
"prompt": "镜头缓慢推进,保持主体外观一致。",
"duration": 3,
"size": "720p",
"metadata": {
"action": "referenceGenerate"
},
"images": [
"https://example.com/frame-1.png"
]
}'
python
import json
import os
import requests
url = "https://api.tu-zi.com/v1/videos"
headers = json.loads("{\"Authorization\":\"Bearer YOUR_API_KEY\",\"Content-Type\":\"application/json\"}")
for name in ["API_KEY"]:
if not os.environ.get(name, "").strip():
raise RuntimeError("Set environment variable: " + name)
headers["Authorization"] = "Bearer " + os.environ["API_KEY"]
payload = json.loads("{\"model\":\"viduq3-ad\",\"prompt\":\"镜头缓慢推进,保持主体外观一致。\",\"duration\":3,\"size\":\"720p\",\"metadata\":{\"action\":\"referenceGenerate\"},\"images\":[\"https://example.com/frame-1.png\"]}")
response = requests.request("POST", url, headers=headers, json=payload, timeout=120)
response.raise_for_status()
result = response.json()
if isinstance(result, dict) and (result.get("success") is False or result.get("code") is False or result.get("error")):
raise RuntimeError(json.dumps(result, ensure_ascii=False))
print(json.dumps(result, ensure_ascii=False, indent=2))
javascript
// Node.js 20+
const url = "https://api.tu-zi.com/v1/videos";
const headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Content-Type": "application/json"
};
for (const name of ["API_KEY"]) {
if (!process.env[name]?.trim()) throw new Error("Set environment variable: " + name);
}
headers.Authorization = 'Bearer ' + process.env.API_KEY;
const response = await fetch(url, { method: "POST", headers, body: JSON.stringify({
"model": "viduq3-ad",
"prompt": "镜头缓慢推进,保持主体外观一致。",
"duration": 3,
"size": "720p",
"metadata": {
"action": "referenceGenerate"
},
"images": [
"https://example.com/frame-1.png"
]
}), signal: AbortSignal.timeout(120000) });
if (!response.ok) throw new Error(await response.text());
const result = await response.json();
if (result?.success === false || result?.code === false || result?.error) throw new Error(JSON.stringify(result));
console.log(JSON.stringify(result, null, 2));
任务结果与下载
保存提交返回的 id 或 task_id。统一视频查询使用 GET /v1/videos/{task_id},等待 queued / in_progress 到 completed 或 failed;完成后读取 video_url(部分响应同时在 metadata.url 提供)。本站相对路径需与调用域名拼接,/content 入口使用本站 Key;外部下载 URL 不携带本站 Key。结果可能过期,请及时下载。网络超时保留任务 ID 继续 GET,不自动重试创建 POST。
统一视频完整 Python / JavaScript 轮询下载示例
常见问题定位
| 现象 | 检查方式 |
|---|---|
| Error validating image / 图片 URI 错误 | 视频或任务 ID 是否误填到了图片字段;检查媒体 URL 是否返回真实素材 |
| unsupported content type / 字段不支持 | 检查系列、版本和 content/contents/input 的准确类型;不要把音频 URL 填入 voice_id |
| 400 参数冲突 | 检查 prompt 与 input、首尾帧与多参考、秒数与 response_format 的互斥项 |
| HTTP 成功但任务 failed | 记录本站任务 ID、时间、模型、域名和已脱敏参数;按任务错误定位,不能依据提交 200 宣称成功 |
| 404 或不可访问任务 | 确认域名、Key 权限、本站任务类型;不要使用其他站点或官方任务 ID |
| 本地文件无法访问 | 使用系列明确支持的上传方式,或提供可读取的 HTTPS 媒体 URL |
资料与适用范围
适用场景
- 选择视频模型和素材协议
- 排查参数与任务失败
API 协议
/v1/videos
常见问题
拿到 task_id 就代表生成成功吗?
不代表。保存本站任务 ID,查询到成功终态并确认结果可读取后才算完成;failed 要查看错误,不要自动重建任务。
本地图片、视频和 WAV 能直接填写路径吗?
不能。URL 字段需要服务可读取的媒体地址;localhost、电脑路径及需要浏览器登录的链接不可用。Kling 本地 PCM WAV 的 multipart 音色上传需本站先启用该接口(2026-11-15 两站实测均为 404);其他素材按该系列上传或素材流程处理。
能把不同模型的参数和任务 ID 互换吗?
不能假定兼容。核对精确型号、入口、大小写、媒体角色及互斥字段。编辑、草稿和音色都要求对应类型、本人可访问的成功任务;官方能力也不等于本站已验收。
兔子API