ARMesh
一、接口描述
1. 功能描述
基于人脸关键点,检测图片中的人脸,实现自然融合的面具贴合
2. 接口数据要求:
- 编码格式:UTF-8
3. 接口使用:
平台为每个API提供试用体验服务,您在AI市场选择“免费试用”规格下单后,即可开始体验业内领先的人工智能API服务。 免费试用服务具有调用量、QPS限制,如需更高性能的API服务,可以提交咨询工单,联系京东AI扩容购买。
在获得使用权限后,您可使用已经封装好的SDK/参照接口鉴权规则进行相应开发,整体流程详见 接入流程
用户需要使用图片base64编码去做请求,使用其他图片的base64编码请求成功时也会加入计费。
二、请求说明
1. 接口地址 :
https://aiapi.jd.com/Faceunity/armesh
2. 请求方式:
post
3. 请求参数
(1)query请求参数
公共请求参数
名称 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
appkey | String | 是 | 80d2b762ecb86593f9668526920f46c | 您的appkey,可在买家中心控制台中获取 |
timestamp | long | 是 | 1541491668060 | 请求的时间戳,精确到毫秒,timestamp有效期5分钟 |
sign | String | 是 | 2e148773a0337a8f2200ba90d445f083 | 签名,根据规则MD5(sectetkey+timestamp) |
item | String | 是 | bluebird | 选择渲染的道具(默认道具) |
(2)body请求参数
业务请求参数
名称 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
image | File | 是 | 需要进行ARMesh的图片,FormData方式上传 |
(4)请求代码示例
建议您使用我们提供的SDK进行调用,SDK获取及调用方式详见本页一接口描述中的2接口使用
三、返回说明
1.返回参数
(1)公共返回参数
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | string | 1000 | 参见下方错误码-系统级错误码 |
charge | boolean | false 或 true | false:不扣费, true:扣费 |
remainTimes | long | 1305 | 剩余调用次数;免费api:每天剩余调用次数;收费api:剩余次数;无限制时为-1 |
remainSeconds | long | 1223456 | 剩余调用时间(s);免费api:-1;收费api:剩余调用时间;无限制时为-1 |
msg | string | 查询成功 | 参见下方错误码-系统级错误码 |
result | object | {...} | 查询结果 |
(2)业务返回参数
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | number | 2 | 请求结果,0为请求失败,1为请求不合法,2为成功,详细参见下方错误码 |
type | string | Sync 或 Async | 同步或异步(Sync/Async) |
message | string | 成功 | 返回信息 |
data | string | 返回base64编码后的图片数据 |
四、错误码信息
1.系统级错误码
2.业务错误码
code | message | 说明 |
---|---|---|
0 | Error | 错误 |
1 | Warning | 警告 |
2 | Success | 成功 |
4 | Wrong Parameter | 参数错误 |
5 | Processing Failed | 处理失败 |
6 | Wrong Token Or Expired | Token不存在或已过期 |
7 | UGC ERROR | UGC处理报错 |
8 | File Too Large | 上传文件过大 |
9 | File Expire Or More Than 5 Times Download | 文件已过期或超过下载次数 |
10 | Item Not Exist | 道具不存在 |
道具列表:
ARMesh道具列表
item | 图示 | item | 图示 |
---|---|---|---|
bluebird | fenhudie | ||
huanghudie | lanhudie | ||
tiger_bai | tiger_huang | ||
zihudie | baozi | ||
tiger | xiongmao |