接口文档--3d游戏特效-火山引擎

文档中心

导航

接口文档

最近更新时间：2022.08.23 16:56:33首次发布时间：2021.12.16 18:40:24

接入指引

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

请求API

名称	内容
请求方式	POST
Content-Type	application/x-www-form-urlencoded
图片要求	1. 图片格式：JPG、JPEG、PNG、BMP等常见格式，建议使用JPG格式。 2. 图片文件大小：最大 5 MB。

输入参数

Query参数：

参数	可选/必选	类型	说明
Action	必选	String	接口名，取值：3DGameCartoon
Version	必选	String	版本号，取值：2020-08-26

Body参数：

参数	可选/必选	类型	说明
image_url	必选（image_url/image_base64 二选一）	String	含人脸的待处理照片URL
image_base64	必选（image_url/image_base64 二选一）	String	传入图片的Base64编码

API返回

通用返回字段说明

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

data 字段说明

字段	类型	说明	备注
image	String	矫正后的图片，返回图片的Base64编码

错误码

HttpCode	错误码	错误消息	描述
200	10000	无	请求成功
400	60102	"Invalid Input Parameters: no face detected in image"	输入图片中没有检测到人脸

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

返回值示例

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