## 说明该服务为异步调用，分为`任务提交`和`任务结果查询`两步骤。 ## 接口简介基于多模态AI算法分析视频内容及结构，提取输入的长视频中的精彩片段并剪除重复内容，返回长视频浓缩后的摘要短视频结果。 ## 限制条件 |

名称

|内容 |\ |---|---| | | | |

视频要求

名称

|内容 |\ |---|---| | | | |

接口地址

|[https://visual.volcengineapi.com](https://visual.volcengineapi.com/) |\ | | | |

请求方式

|POST |\ | | | |

Content\-Type

|`application/x-www-form-urlencoded` |\ | | | **请求参数** **（1）header请求参数** 公共请求参数以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见 [公共参数](https://www.volcengine.com/docs/6369/67268) |名称 |类型 |是否必填 |描述 | |---|---|---|---| |X\-Date |String |是 |使用UTC时间，精确到秒。请使用格式：`YYYYMMDD'T'HHMMSS'Z'` ，例如：`20201103T104027Z` | |Authorization |String |是 |HMAC\-SHA256：签名方法|\ | | | |\-**Credential**为签名凭证，其中:|\ | | | |\-**AccessKeyId**为访问密钥ID，可在 [访问密钥（Access Key）](https://www.volcengine.com/docs/6291/65568) 获取；|\ | | | |\-**ShortDate**为请求的短时间，使用UTC时间，精确到日。请使用格式：`YYYYMMDD`，例如：`20180201`；|\ | | | |\-**Region**为请求地区，国内一般为为`cn-north-1`；|\ | | | |\-**Service**为请求的服务，一般为`cv`；|\ | | | |\-**SignedHeaders**为参与签名计算的头部信息，`content-type` 和 `host` 为必选头部；|\ | | | |\-**Signature**为签名，可在 [签名方法](https://www.volcengine.com/docs/6369/67269) 获取。|\ | | | |注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考 [快速接入](https://www.volcengine.com/docs/6444/69729)|\ | | | |例如：`HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}` | |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）通用输出参数** 通用输出参数具体见[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) **（2）业务输出参数** `data`字段说明 |

字段

|

类型

|

说明

|\ |---|---|---| | | | | |

task_id

|

String

|

任务编号，用于查询任务运行状态和结果

|\ | | | | **（3）输出示例** ```json { "status": 10000, "code": 10000, "time_elapsed": "570.835792ms", "request_id": "69048264100455403521607655177", "message": "Success", "data": { "task_id": {任务id} } } ``` ### 错误码（1）通用错误码请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) （2）业务错误码 |http code |错误码 |错误信息 |说明 | |---|---|---|---| |200 |10000 |Success |成功 | |400 |50201 |Missing Input Parameters: |缺少输入参数param，param可能为video、result_duration | |400 |50200 |Invalid Input Parameters: |输入参数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）通用输出参数** 通用输出参数具体见[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) **（2）业务输出参数** `data`字段说明 |

字段

|

类型

|

说明

|\ |---|---|---| | | | | |

status

|

String

|

任务运行状态，可能为：Pending、Running、Success、Failed

|\ | | | | |

video_url

|

String

|

处理后的视频链接，链接有效时长为1h，超过请重新请求该接口获取，仅当status为Success时该值有效，当status为Failed时请查看错误码。

|\ | | | | 注： 1. 部分视频编码无法在浏览器正常播放，可尝试下载后使用视频播放器播放。 2. `data`字段包含在通用返回字段中，具体见[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728)。 **（3）输出示例** ```json { "status": 10000, "code": 10000, "time_elapsed": "570.835792ms", "request_id": "69048264100455403521607655177", "message": "Success", "data": { "status": "Success" "video_url": {视频链接} } } ``` ### 错误码（1）通用错误码请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728)。（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 |服务处理超时 |

视频技术