1. 接口描述
接口请求域名: bda.tencentcloudapi.com 。
本接口为人像分割在线处理接口组中的提交任务接口,可以对提交的资源进行处理视频流/图片流识别视频作品中的人像区域,进行一键抠像、背景替换、人像虚化等后期处理。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateSegmentationTask。 |
Version | 是 | String | 公共参数,本接口取值:2020-03-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou 。 |
VideoUrl | 是 | String | 需要分割的视频URL,可外网访问。 示例值:test.video.url |
BackgroundImageUrl | 否 | String | 背景图片URL。 可以将视频背景替换为输入的图片。 如果不输入背景图片,则输出人像区域mask。 示例值:test.image.url |
Config | 否 | String | 预留字段,后期用于展示更多识别信息。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskID | String | 任务标识ID,可以用与追溯任务状态,查看任务结果 示例值:fakeTaskID |
EstimatedProcessingTime | Float | 预估处理时间,单位为秒 示例值:30 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建任务成功
创建视频人像分割处理任务成功
输入示例
POST / HTTP/1.1
Host: bda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSegmentationTask
<公共请求参数>
{
"VideoUrl": "test.video.url",
"BackgroundImageUrl": "test.image.url"
}
输出示例
{
"Response": {
"RequestId": "33c35bff-27b6-408f-9ca7-19191303fa07",
"TaskID": "fakeTaskID",
"EstimatedProcessingTime": 30
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.DownloadError | 文件下载失败。 |
FailedOperation.ImageDownloadError | 图片下载错误。 |
FailedOperation.InnerError | 服务内部错误,请重试。 |
FailedOperation.JobConflict | 任务冲突。 |
FailedOperation.JobQueueFull | 任务队列已满。 |
FailedOperation.RequestTimeout | 后端服务超时。 |
FailedOperation.RpcFail | RPC请求失败,一般为算法微服务故障。 |
FailedOperation.TaskLimitExceeded | 任务超过上限。 |
FailedOperation.TooLargeFileError | 文件太大。 |
FailedOperation.UnKnowError | 内部错误。 |
InvalidParameter.InvalidParameter | 参数不合法。 |