最近更新时间:2022.09.15 16:31:30
首次发布时间:2022.07.21 16:22:01
该服务为异步调用,分为任务提交
和任务结果查询
两步骤。
基于多模态AI算法分析视频内容及结构,提取输入的长视频中的精彩片段并剪除重复内容,返回长视频浓缩后的摘要短视频结果。
名称 | 内容 |
---|---|
视频要求 | 1.视频格式:h264编码格式,非该格式会造成服务内部错误 2.视频大小不超过380MB |
名称 | 内容 |
---|---|
接口地址 | https://visual.volcengineapi.com |
请求方式 | POST |
Content-Type | application/x-www-form-urlencoded |
请求参数
(1)header请求参数
公共请求参数
以下请求参数列表仅列出了接口请求参数和必要公共参数,完整公共参数列表见 公共参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
X-Date | String | 是 | 使用UTC时间,精确到秒。请使用格式:YYYYMMDD'T'HHMMSS'Z' ,例如:20201103T104027Z |
Authorization | String | 是 | HMAC-SHA256:签名方法 |
X-Security-Token | String | 否 | 指安全令牌服务(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_id | String | 任务编号,用于查询任务运行状态和结果 |
(3)输出示例
{ "status": 10000, "code": 10000, "time_elapsed": "570.835792ms", "request_id": "69048264100455403521607655177", "message": "Success", "data": { "task_id": {任务id} } }
(1)通用错误码
请参考通用返回字段及错误码
(2)业务错误码
http code | 错误码 | 错误信息 | 说明 |
---|---|---|---|
200 | 10000 | Success | 成功 |
400 | 50201 | Missing Input Parameters: {param} | 缺少输入参数param,param可能为video、result_duration |
400 | 50200 | Invalid Input Parameters: {param} | 输入参数param不合规,param可能为video、result_duration、result_width |
400 | 50200 | Invalid Input Parameters: Video Unchanged | 输入参数不合规,视频不需要任何处理 |
400 | 50211 | Video Size Exceeds Maximum Limit: please compress the video | 输入视频过大,超过限制 |
500 | 50500 | Internal Error | 服务内部错误 |
名称 | 内容 |
---|---|
请求方式 | GET |
Content-Type | application/x-www-form-urlencoded |
是否需要鉴权 | 是 |
Query参数:
参数 | 可选/必选 | 类型 | 说明 |
---|---|---|---|
Action | 必选 | String | 接口名,取值:VideoSummarizationQueryTask |
Version | 必选 | String | 版本号,取值:2020-08-26 |
task_id | 必选 | String | 任务ID |
(1)通用输出参数
通用输出参数具体见通用返回字段及错误码
(2)业务输出参数
data
字段说明
字段 | 类型 | 说明 |
---|---|---|
status | String | 任务运行状态,可能为:Pending、Running、Success、Failed |
video_url | String | 处理后的视频链接,链接有效时长为1h,超过请重新请求该接口获取,仅当status为Success时该值有效,当status为Failed时请查看错误码。 |
注:
data
字段包含在通用返回字段中,具体见通用返回字段及错误码。(3)输出示例
{ "status": 10000, "code": 10000, "time_elapsed": "570.835792ms", "request_id": "69048264100455403521607655177", "message": "Success", "data": { "status": "Success" "video_url": {视频链接} } }
(1)通用错误码
请参考通用返回字段及错误码。
(2)业务错误码
http code | 错误码 | 错误信息 | 说明 |
---|---|---|---|
200 | 10000 | Success | 成功 |
400 | 50201 | Missing Input Parameters: task_id | 缺少输入参数task_id |
400 | 50200 | Invalid Input Parameters: task_id | 输入参数task_id无效 |
500 | 50500 | Internal Error | 服务内部错误 |
500 | 50502 | Processing time is too long, exceeding the limit | 服务处理超时 |