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

接口文档

最近更新时间2021.08.03 19:46:15

首次发布时间2021.02.23 10:42:11

接入指引

请先查看接入指引了解具体接入方式,再参考此文档完成接入。

说明

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

任务提交
名称内容
请求方式POST
Content-Typeapplication/x-www-form-urlencoded
是否需要鉴权
视频要求1.视频格式:h264编码格式,非该格式会造成服务内部错误.
2.视频大小不超过380MB

输入参数

Query参数:

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

Body参数:

参数可选/必选类型说明
video_url必选String视频链接,受网络因素影响可能会导致任务失败
result_duration必选Int视频超分输出时长,单位s,若大于原视频长度则返回原视频
result_width可选Int输出视频结果的宽度(像素),如果不设置则默认为360p,即宽度为640,宽度与分辨率的关系如下

result_width参数与输出视频分辨率的关系

输入输出
width >= 1920definition = 1080p
width >= 1280definition = 720p
width >= 848definition = 480p
width >= 640definition = 360p

API返回

data字段

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

注:data字段包含在通用返回字段中,具体见通用返回字段及错误码

错误码

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服务内部错误

注:其余请参考通用返回字段及错误码

返回示例

{
    "status": 10000,
    "code": 10000,
    "time_elapsed": "570.835792ms",
    "request_id": "69048264100455403521607655177",
    "message": "Success",
    "data": {
        "task_id": {任务id}
    }
}
任务结果查询
名称内容
请求方式GET
Content-Typeapplication/x-www-form-urlencoded
是否需要鉴权

输入参数

Query参数:

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

API返回

data字段

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

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

错误码

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服务处理超时

注:其余请参考通用返回字段及错误码

返回示例

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