# 创建参考生视频生成任务
#### 功能介绍
根据用户输入的参考图像和文本提示词，生成视频。**适用生数模型。**
#### URI
POST https://api.modelarts-maas.com/v1/video/generations
#### 请求参数
表1请求Header参数 
| 参数            | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| Authorization | 是    | String | **参数描述：** API Key 鉴权凭证，从 MaaS 控制台获取，调用推理API时从请求头 Authorization 字段传入，值格式为：Bearer MaaS_API_Key。 |
   
表2请求Body参数 
| 参数         | 是否必选 | 参数类型                                                                                                                             | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|:---|
| model      | 是    | String                                                                                                                           | **参数解释：** 支持视频生成的模型名称。 **约束限制：** 不涉及。 **取值范围：** vidu/viduq3-turbo_reference2video vidu/viduq3-mix_reference2video vidu/viduq3-ad_reference2video **默认取值：** 不涉及。 |
| input      | 是    | [input] object           | 输入基本信息，包含提示词、媒体素材等。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| parameters | 否    | [parameters] object | 视频处理参数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
   
 表3input 
| 参数     | 是否必选 | 参数类型                                                                                                                             | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| prompt | 是    | String                                                                                                                           | **参数解释：** 文本提示词，支持中英文。 **约束限制：** 不涉及。 **取值范围：** 文本最大长度为5000字符。 **默认取值：** 不涉及。 |
| media  | 是    | Array of [media] objects | 媒体素材列表，图生视频情况下必填，用于指定视频生成所需的图像。 数组的每个元素为一个媒体对象，包含 type 与 url 字段。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
   
 表4media 
| 参数   | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|:---|
| type | 是    | String | **参数解释：** 媒体素材类型。 **约束限制：** 不涉及。 **取值范围：** - image_url：图像URL。多主体参考生视频模型使用时，可传1\~7张。    **默认取值：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| url  | 是    | String | **参数解释：** 图像文件的URL地址。 **约束限制：** - 仅支持公网可访问URL。   - 支持的图片的格式：jpg、png、webp、jpeg。  - 生数系列模型单个图片文件的大小不超过50MB。 示例："url": "https://example/image.jpg"    **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
 表5parameters 
| 参数        | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| size      | 否    | String  | **参数解释：** 生成视频的分辨率。 **约束限制：** 不涉及。 **取值范围：** 字段格式说明：传入字段格式为 1280\*720。 生成视频的分辨率档位，不同视频宽高比对应的分辨率如下： - 540P档位： - 16:9：960\*540   - 9:16：540\*960      - 720P档位： - 16:9：1280\*720   - 9:16：720\*1280      - 1080P档位： - 16:9：1920\*1080   - 9:16：1080\*1920       vidu/viduq3-turbo_reference2video支持540P、720P、1080P。 vidu/viduq3-mix_reference2video支持720P、1080P。 vidu/viduq3-ad_reference2video支持720P、1080P。 **默认取值：** 1280\*720 |
| duration                                                            | 否                                                              | Integer                                                           | **参数解释：** 视频时长，单位秒。 **约束限制：** 不涉及。 **取值范围：** - vidu/viduq3-turbo_reference2video：\[1, 16\]  - vidu/viduq3-mix_reference2video：\[1, 15\]  - vidu/viduq3-ad_reference2video：\[1, 15\]   **默认取值：** 5。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| seed      | 否    | Integer | **参数解释：** 随机种子，用于控制生成内容的随机性。 **约束限制：** 不涉及。 **取值范围：** - 最小值：0   - 最大值：2147483648    **默认取值：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| audio     | 否    | Boolean | **参数解释：** 是否生成音频。 **约束限制：** 不涉及。 **取值范围：** - false：默认值，输出无声视频。   - true：输出有声视频。    **默认取值：** true：输出有声视频。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| shot_type | 否    | String  | **参数解释：** 指定生成视频的镜头类型，控制视频是由一个连续镜头还是多镜头组成。 **约束限制：** 不涉及。 **取值范围：** - single：默认值，生成单镜头视频。   - multi：多镜头，系统会进行智能分镜。    **默认取值：** single：生成单镜头视频。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
   
#### 响应参数
**状态码：200**
表6响应Body参数 
| 参数      | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|
| task_id | String | **参数描述：** 视频生成后的任务ID。 **取值范围：** 不涉及。 |
   
#### 请求示例
- 图生视频（基于参考图）（以vidu/viduq3-turbo_reference2video 为例）- Python
  ```
  import requests
  import json
  if __name__ == '__main__':
      url = "https://api.modelarts-maas.com/v1/video/generations"  # API地址
      api_key = "MAAS_API_KEY"  # 把 MAAS_API_KEY 替换成已获取的API Key
      # Send request.
      headers = {
          'Content-Type': 'application/json',
          'Authorization': f'Bearer {api_key}'
      }
      data = {
    "model": "vidu/viduq3-turbo_reference2video",
    "input": {
  "prompt": "蓝天白云下的郊外草原，微风拂动青草，羊群缓慢走动，远处有连绵青山。",
  "media": [
    {
  "type": "image_url",
  "url": "https://example/image1.jpg"
    },
    {
  "type": "image_url",
  "url": "https://example/image2.jpg"
    },
    {
  "type": "image_url",
  "url": "https://example/image3.jpg"
    }
  ]
    },
    "parameters": {
  "size": "1280*720",
                  "duration": 5,
  "audio": False
    }
  }
      response = requests.post(url, headers=headers, data=json.dumps(data), verify=False)
      # Print result.
      print(response.status_code)
      print(response.text)
  ```
  
- 图生视频（基于参考图）（vidu/viduq3-turbo_reference2video 为例）- curl
  ```
  curl -X POST "https://api.modelarts-maas.com/v1/video/generations" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer $MAAS_API_KEY" \
    -d '{
    "model": "vidu/viduq3-turbo_reference2video",
    "input": {
  "prompt": "蓝天白云下的郊外草原，微风拂动青草，羊群缓慢走动，远处有连绵青山。",
  "media": [
    {
  "type": "image_url",
  "url": "https://example/image1.jpg"
    },
    {
  "type": "image_url",
  "url": "https://example/image2.jpg"
    },
    {
  "type": "image_url",
  "url": "https://example/image3.jpg"
    }
  ]
    },
    "parameters": {
  "size": "1280*720",
                  "duration": 5,
  "audio": false
    }
  }'
  ```
  
 
#### 响应示例
**状态码：200**
视频生成任务创建成功。
```
{
  "task_id" : "964395715545571329"
}
```
#### 状态码
| 状态码 | 描述          |
|:---|:---|
| 200 | 视频生成任务创建成功。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/model-call-maas/model-call-035.html)。
