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

# Vidu 视频生成

> 使用 `POST /v1/videos` 调用 Vidu 模型提交异步视频任务。

# Vidu 视频生成

Vidu 渠道使用 `POST /v1/videos` 提交任务,以 `multipart/form-data` 提交。

* 路由入口是 `POST /v1/videos`。
* 当前使用 `multipart/form-data` 提交。
* 支持文生视频、图生视频。
* 参考图通过 `images` 字段上传单个文件。
* 提交成功后返回任务 `id` 与 `status`,后续用 [任务状态查询](./vidu-query) 轮询结果。

## 支持模型

* `viduq3-pro`: 高效生成优质音视频内容,让视频内容更生动、更形象、更立体
* `viduq2-pro`: 新模型,效果好,细节丰富
* `viduq2-turbo`: 新模型,效果好,生成快

## 方法与路径

```http theme={null}
POST /v1/videos
```

## 请求示例

<CodeGroup>
  ```bash theme={null}
  curl -X POST https://octopusx.ai/v1/videos \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -F "model=viduq3-pro" \
    -F "prompt=一只猫在草地上追逐蝴蝶" \
    -F "aspect_ratio=16:9" \
    -F "duration=5"
  ```

  ```python theme={null}
  import requests

  resp = requests.post(
      "https://octopusx.ai/v1/videos",
      headers={"Authorization": "Bearer YOUR_API_KEY"},
      data={
          "model": "viduq3-pro",
          "prompt": "一只猫在草地上追逐蝴蝶",
          "aspect_ratio": "16:9",
          "duration": 5,
      },
      timeout=60,
  )
  print(resp.json())
  ```
</CodeGroup>

### 图生视频示例

<CodeGroup>
  ```bash theme={null}
  # 带参考图的请求示例
  curl -X POST https://octopusx.ai/v1/videos \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -F "model=viduq3-pro" \
    -F "prompt=让人物向前走并微笑" \
    -F "aspect_ratio=9:16" \
    -F "duration=5" \
    -F "images=@/path/to/image.png"
  ```

  ```python theme={null}
  # 带参考图的请求示例
  import requests

  with open("image.png", "rb") as f:
      resp = requests.post(
          "https://octopusx.ai/v1/videos",
          headers={"Authorization": "Bearer YOUR_API_KEY"},
          data={
              "model": "viduq3-pro",
              "prompt": "让人物向前走并微笑",
              "aspect_ratio": "9:16",
              "duration": 5,
          },
          files={"images": f},
          timeout=60,
      )
      print(resp.json())
  ```
</CodeGroup>

## 响应示例

<ResponseExample>
  ```json 200 theme={null}
  {
    "id": "video_123",
    "object": "video",
    "model": "viduq3-pro",
    "status": "queued",
    "progress": 0,
    "created_at": 1712697600,
    "size": "1024x1808",
    "seconds": "5",
    "quality": "standard"
  }
  ```
</ResponseExample>

## 认证

```http theme={null}
Authorization: Bearer YOUR_API_KEY
```

## Body

<ParamField body="model" type="string" required>
  模型名称。支持 `viduq3-pro`、`viduq2-pro`、`viduq2-turbo`。
</ParamField>

<ParamField body="prompt" type="string" required>
  文本提示词。生成视频的文本描述。若使用 `is_rec` 推荐提示词参数,模型将不考虑此参数所输入的提示词。
</ParamField>

<ParamField body="images" type="file">
  参考图。上传单个图片文件,用于图生视频场景。支持传入图片 Base64 编码或图片 URL(确保可访问)。只支持输入 1 张图,图片支持 png、jpeg、jpg、webp 格式。图片比例需要小于 1:4 或者 4:1,图片大小不超过 50 MB。
</ParamField>

<ParamField body="aspect_ratio" type="string">
  画幅比例。可选值包括 `16:9`(默认)、`9:16`、`3:4`、`4:3`、`1:1`。注:`3:4`、`4:3` 仅支持 q2、q3 模型。
</ParamField>

<ParamField body="audio" type="boolean">
  是否使用音视频直出能力。`false`:不需要音视频直出,输出静音视频;`true`:需要音视频直出,输出带台词以及背景音的视频。
</ParamField>

<ParamField body="voice_id" type="string">
  音色 ID,q3 模型不生效。用来决定视频中的声音音色,为空时系统会自动推荐。
</ParamField>

<ParamField body="is_rec" type="boolean">
  是否使用推荐提示词。`true`:由系统自动推荐提示词,并使用提示词内容生成视频,推荐提示词数量=1;`false`:根据输入的 prompt 生成视频。
</ParamField>

<ParamField body="bgm" type="boolean">
  是否为生成的视频添加背景音乐。`true`:系统将从预设 BGM 库中自动挑选合适的音乐并添加;`false`:不添加 BGM。
</ParamField>

<ParamField body="duration" type="integer">
  视频时长(秒)。viduq2 系列默认为 5,可选:1-10。
</ParamField>

<ParamField body="seed" type="integer">
  随机种子。当默认不传或者传 0 时,会使用随机数替代。手动设置则使用设置的种子。
</ParamField>

<ParamField body="resolution" type="string">
  分辨率。默认值依据模型和视频时长而定。`viduq2-pro` 1-10 秒:默认 720p,可选:540p、720p、1080p;`viduq2-turbo` 1-10 秒:默认 720p,可选:540p、720p、1080p。
</ParamField>

<ParamField body="payload" type="string">
  透传参数。不做任何处理,仅数据传输。
</ParamField>

<ParamField body="off_peak" type="boolean">
  错峰模式。`true`:错峰生成视频;`false`:即时生成视频。
</ParamField>

<ParamField body="watermark" type="boolean">
  是否添加水印。`true`:添加水印;`false`:不添加水印。
</ParamField>

<ParamField body="wm_position" type="integer">
  水印位置。`1`:左上角;`2`:右上角;`3`:右下角;`4`:左下角。
</ParamField>

<ParamField body="wm_url" type="string">
  水印内容,此处为图片 URL。不传时,使用默认水印:内容由 AI 生成。
</ParamField>

<ParamField body="meta_data" type="string">
  元数据标识,json 格式字符串,透传字段。
</ParamField>

## Response

<ResponseField name="id" type="string">
  任务 ID。
</ResponseField>

<ResponseField name="object" type="string">
  固定为 `video`。
</ResponseField>

<ResponseField name="model" type="string">
  模型名称。
</ResponseField>

<ResponseField name="status" type="string">
  任务状态。可选值包括 `queued`(排队中)、`processing`(处理中)、`completed`(已完成)、`failed`(失败)、`cancelled`(已取消)。
</ResponseField>

<ResponseField name="progress" type="integer">
  进度百分比(0-100)。
</ResponseField>

<ResponseField name="created_at" type="integer">
  创建时间(Unix 时间戳)。
</ResponseField>

<ResponseField name="size" type="string">
  视频尺寸,例如 `1024x1808`。
</ResponseField>

<ResponseField name="seconds" type="string">
  视频时长(秒)。
</ResponseField>

<ResponseField name="quality" type="string">
  视频质量,例如 `standard`。
</ResponseField>

## 相关接口

* [Vidu 视频概览](./overview)
* [任务状态查询](./vidu-query)