跳转至

文本生视频接口文档

版本历史

版本号 日期 修改内容
v1.0 2024-08-29 初版

MaaS Haiper Video

公共信息

参数 描述 示例
basePath 调用mass api的基础路径，包含/v1/ai固定路径 https://genaiapi.cloudsway.net/v1/ai
endpointPath 调用mass api的生成的一段随机路径 LPUqHEAjfonOmohV
AccessKey 调用mass api的accessKey RWxxxxxxxx0Gd
taskId 异步处理视频任务的任务id 1234abcd

按照上面示例,最终请求接口的路径为https://genaiapi.cloudsway.net/v1/ai/LPUqHEAjfonOmohV/video/generate

生成视频

请求方法

POST

请求路径

{basePath}/{endpointPath}/video/generate

参数 描述 示例
Authorization AccessKey
Bearer ${AccessKey}		 Bearer RWxxxxxxxx0Gd

请求body

字段名 类型 是否必填 描述 示例值
prompt String 是 提示词 "Generate a video of a sunset over the ocean."
negativePrompt String 否 负面提示词 "Avoid dark and gloomy scenes."
config Object 否 配置项
- sourceImage URI 否 源图像的公共URL，支持http和https "https://demo.jpg"
settings Object 否 设置项
- seed Number 否 默认值为-1，用于采样的随机种子 42
- duration Number 否 默认值为2，输出视频的时长，支持2、4和8 2
- aspectRatio String 否 默认值为16:9，有效值为(16:9, 9:16, 3:4, 4:3, 1:1) "16:9"

返回值

字段名 类型 描述 示例值
taskId String 任务的唯一标识 "1234abcd"

示例

请求

curl -X POST "https://genaiapi.cloudsway.net/v1/ai/LPUqHEAjfonOmohV/video/generate" \
  -H "Authorization: Bearer RWxxxxxxxx0Gd" \
  -H "Content-Type: application/json" \
  -d '{
        "prompt": "Generate a video of a sunset over the ocean.",
        "negativePrompt": "Avoid dark and gloomy scenes.",
        "config": {
          "sourceImage": "https://demo.jpg"
        },
        "settings": {
          "seed": 42,
          "duration": 2,
          "aspectRatio": "16:9"
        }
      }'

返回值

{
  "taskId": "1234abcd"
}

提高视频像素

请求方法

POST

请求路径

{basePath}/{endpointPath}/video/upscale

请求header

参数 描述 示例
Authorization AccessKey
Bearer ${AccessKey}		 Bearer RWxxxxxxxx0Gd

请求body

字段名 类型 是否必填 描述 示例值
config Object 是 配置项
- sourceVideo URI 是 源视频的公共URL，支持http和https "https://demo.mp4"

返回值

字段名 类型 描述 示例值
taskId String 任务的唯一标识 "1234abcd"

示例

请求

curl -X POST "https://genaiapi.cloudsway.net/v1/ai/LPUqHEAjfonOmohV/video/upscale" \
  -H "Authorization: Bearer RWxxxxxxxx0Gd" \
  -H "Content-Type: application/json" \
  -d '{
        "config": {
          "sourceVideo": "https://demo.mp4"
        }
      }'

返回值

{
  "taskId": "1234abcd"
}

扩展视频

请求方法

POST

请求路径

{basePath}/{endpointPath}/video/extend

请求header

参数 描述 示例
Authorization AccessKey
Bearer ${AccessKey}		 Bearer RWxxxxxxxx0Gd

请求body

字段名 类型 是否必填 描述 示例值
prompt String 否 提示词 "Generate a video of a sunset over the ocean."
negativePrompt String 否 负面提示词 "Avoid dark and gloomy scenes."
config Object 是 配置项
- sourceVideo URI 是 源视频的公共URL，支持http和https "https://demo.mp4"
- extendDuration Number 否 默认值为4，视频扩展时长，可选2和4秒 4
settings Object 否 设置项
- seed Number 否 默认值为-1，用于采样的随机种子 42
- guidanceScale Number 否 默认值为7.5，设置指导尺度 7.5

返回值

字段名 类型 描述 示例值
taskId String 任务的唯一标识 "1234abcd"

示例

请求

curl -X POST "https://genaiapi.cloudsway.net/v1/ai/LPUqHEAjfonOmohV/video/extend" \
  -H "Authorization: Bearer RWxxxxxxxx0Gd" \
  -H "Content-Type: application/json" \
  -d '{
        "prompt": "Generate a video of a sunset over the ocean.",
        "negativePrompt": "Avoid dark and gloomy scenes.",
        "config": {
          "sourceVideo": "https://demo.mp4",
          "extendDuration": 4
        },
        "settings": {
          "seed": 42,
          "guidanceScale": 7.5
        }
      }'

返回值

{
  "taskId": "1234abcd"
}

查询视频任务结果

请求方法

GET

请求路径

{basePath}/{endpointPath}/video/tasks/{taskId}

请求header

参数 描述 示例
Authorization AccessKey
Bearer ${AccessKey}		 Bearer RWxxxxxxxx0Gd

pathVariables

字段名 类型 描述 示例值
taskId String 任务的唯一标识 "1234abcd"

返回值

字段名 类型 描述 示例值
status String 任务状态，可选值：PENDING, IN_PROGRESS, SUCCESS, FAIL SUCCESS
mediaUrl String 生成的媒体文件URL
expireTime Number URL过期时间的时间戳 1724241996259
progress Number 进度，1代表完成 0.85

示例

请求

curl -X GET "https://genaiapi.cloudsway.net/v1/ai/LPUqHEAjfonOmohV/video/tasks/1234abcd" \
  -H "Authorization: Bearer RWxxxxxxxx0Gd"

返回值

{
  "status": "SUCCESS",
  "mediaUrl": "https://generated-video-url.mp4",
  "expireTime": 1724241996259,
  "progress": 0.85
}