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

调用方式

最近更新时间2024.03.13 15:50:28

首次发布时间2022.07.21 16:25:18

接口简介

支持检测图像中的前景主体并识别轮廓,实现精细化背景分割抠图能力,对于镂空主体及复杂背景均有良好效果。目前默认开启审核。

限制条件

名称内容

图片要求

1. 图片格式:JPG、JPEG、PNG、BMP等常见格式,建议使用JPG格式。
2. 图片文件大小:最大 5 MB。

请求说明

名称内容
接口地址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接口名,取值:HumanSegment
Version必选String版本号,取值:2020-08-26

(3)Body参数

业务请求参数

参数可选/必选类型说明
image_base64必选(二选一,优先生效)String图片文件,base64编码
image_url必选(二选一)String图片文件URL
refine可选01int对图像边缘进行精细抠图
return_foreground_image可选01int是否返回前景人像图(透明背景)

输出说明

(1)通用输出参数

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

(2)业务输出参数

字段类型说明备注
maskstring返回通用分割图片的Base64编码
foreground_imagestring人像前景图的base64编码。若return_foreground_image传入1,会返回此字段,否则不会。

(3)输出示例

{
    "code":10000,
    "data":{
        "mask": "",
    },
    "message":"Success",
    "request_id":"6838889517957515275",
    "time_elapsed":"41.897331ms"
}

备注
接口支持通过refine参数配置是否进行边缘精细抠图,0为不进行(默认),1为进行。进行抠图操作会增加接口耗时。
接口支持通过return_foreground_image参数配置是否返回返回前景人像图,0为不返回(默认),1为返回。返回前景人像图会增加接口耗时和带宽消耗。

错误码

(1)通用错误码

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

(2)业务错误码

HttpCode错误码错误消息描述
20010000请求成功
40060802"Human Segment Error"人体分割服务错误
40060803"Invalid Input Image: image refine error"抠图服务错误