You need to enable JavaScript to run this app.
导航

调用方式

最近更新时间2022.09.15 16:31:30

首次发布时间2022.07.21 16:22:01

说明

该服务为异步调用,分为任务提交任务结果查询两步骤。

接口简介

基于多模态AI算法分析视频内容及结构,提取输入的长视频中的精彩片段并剪除重复内容,返回长视频浓缩后的摘要短视频结果。

限制条件

名称内容
视频要求1.视频格式:h264编码格式,非该格式会造成服务内部错误
2.视频大小不超过380MB

任务提交

名称内容
接口地址https://visual.volcengineapi.com
请求方式POST
Content-Typeapplication/x-www-form-urlencoded

请求参数

(1)header请求参数

公共请求参数

以下请求参数列表仅列出了接口请求参数和必要公共参数,完整公共参数列表见 公共参数

名称类型是否必填描述
X-DateString使用UTC时间,精确到秒。请使用格式:YYYYMMDD'T'HHMMSS'Z' ,例如:20201103T104027Z

Authorization

String

HMAC-SHA256:签名方法
-Credential为签名凭证,其中:
-AccessKeyId为访问密钥ID,可在 访问密钥(Access Key) 获取;
-ShortDate为请求的短时间,使用UTC时间,精确到日。请使用格式:YYYYMMDD,例如:20180201
-Region为请求地区,国内一般为为cn-north-1
-Service为请求的服务,一般为cv
-SignedHeaders为参与签名计算的头部信息,content-typehost 为必选头部;
-Signature为签名,可在 签名方法 获取。
注:我们提供了SDK及签名示例供您实现服务快速接入,具体可参考 快速接入
例如:HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

X-Security-TokenString指安全令牌服务(Security Token Service,STS) 颁发的临时安全凭证中的SessionToken,使用长期密钥时无需填写该参数。

(2)Query参数

业务请求参数

参数可选/必选类型说明
Action必选String接口名,取值:VideoSummarizationSubmitTask
Version必选String版本号,取值:2020-08-26

(3)Body参数

业务请求参数

参数可选/必选类型说明
video_url必选String视频链接,受网络因素影响可能会导致任务失败
result_duration必选Int视频超分输出时长,单位s,若大于原视频长度则返回原视频
result_width可选Int输出视频结果的宽度(像素),默认宽度640,会采用保持纵横比的方式调整视频

备注:只支持高分辨率调整为低分辨率,如果宽度设置超过原视频,则不做任何调整,按照原视频分辨率返回结果

输出说明

(1)通用输出参数

通用输出参数具体见通用返回字段及错误码

(2)业务输出参数

data字段说明

字段类型说明
task_idString任务编号,用于查询任务运行状态和结果

(3)输出示例

{
    "status": 10000,
    "code": 10000,
    "time_elapsed": "570.835792ms",
    "request_id": "69048264100455403521607655177",
    "message": "Success",
    "data": {
        "task_id": {任务id}
    }
}

错误码

(1)通用错误码

请参考通用返回字段及错误码

(2)业务错误码

http code错误码错误信息说明
20010000Success成功
40050201Missing Input Parameters: {param}缺少输入参数param,param可能为video、result_duration
40050200Invalid Input Parameters: {param}输入参数param不合规,param可能为video、result_duration、result_width
40050200Invalid Input Parameters: Video Unchanged输入参数不合规,视频不需要任何处理
40050211Video Size Exceeds Maximum Limit: please compress the video输入视频过大,超过限制
50050500Internal Error服务内部错误

任务结果查询

名称内容
请求方式GET
Content-Typeapplication/x-www-form-urlencoded
是否需要鉴权

请求参数

Query参数:

参数可选/必选类型说明
Action必选String接口名,取值:VideoSummarizationQueryTask
Version必选String版本号,取值:2020-08-26
task_id必选String任务ID

输出说明

(1)通用输出参数

通用输出参数具体见通用返回字段及错误码

(2)业务输出参数

data字段说明

字段类型说明
statusString任务运行状态,可能为:Pending、Running、Success、Failed
video_urlString处理后的视频链接,链接有效时长为1h,超过请重新请求该接口获取,仅当status为Success时该值有效,当status为Failed时请查看错误码。

注:

  1. 部分视频编码无法在浏览器正常播放,可尝试下载后使用视频播放器播放。
  2. data字段包含在通用返回字段中,具体见通用返回字段及错误码

(3)输出示例

{
    "status": 10000,
    "code": 10000,
    "time_elapsed": "570.835792ms",
    "request_id": "69048264100455403521607655177",
    "message": "Success",
    "data": {
        "status": "Success"
        "video_url": {视频链接}
    }
}

错误码

(1)通用错误码

请参考通用返回字段及错误码

(2)业务错误码

http code错误码错误信息说明
20010000Success成功
40050201Missing Input Parameters: task_id缺少输入参数task_id
40050200Invalid Input Parameters: task_id输入参数task_id无效
50050500Internal Error服务内部错误
50050502Processing time is too long, exceeding the limit服务处理超时