视频换脸结果查询
一、接口描述
1. 功能描述
查询视频换脸结果。
2. 接口数据要求:
无
3. 接口使用:
平台为每个API提供试用体验服务,您在AI市场选择“免费试用”规格下单后,即可开始体验业内领先的人工智能API服务。 免费试用服务具有调用量、QPS限制,如需更高性能的API服务,可以提交咨询工单,联系京东AI扩容购买。
在获得使用权限后,您可使用已经封装好的SDK/参照接口鉴权规则进行相应开发,整体流程详见 接入流程
二、请求说明
1. 接口地址 :
https://aiapi.jd.com/jdai/face_swap_search
2. 请求方式:
post
3. 请求参数
(1)query请求参数
公共请求参数
名称 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
appkey | String | 是 | 80d2b762ecb86593f9668526920f46c | 您的appkey,可在买家中心控制台中获取 |
timestamp | long | 是 | 1541491668060 | 请求的时间戳,精确到毫秒,timestamp有效期5分钟 |
sign | String | 是 | 2e148773a0337a8f2200ba90d445f083 | 签名,根据规则MD5(sectetkey+timestamp) |
(2)header请求参数
业务请求参数
名称 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
Content-Type | String | 是 | application/json | 请求头格式 |
(3)body请求参数
视频换脸流程
由于视频处理时间较长,所以整体流程设置为异步请求流程。
- 创建视频换脸任务,得到task_id。
- 大约3-5分钟后通过task_id 请求换脸结果查询接口得到换脸后的结果(该接口)。(亦可通过callback_url得到处理完的结果。)
业务请求参数
名称 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
task_id | String | 是 | 'c5721b2b7cdb488fafb1e065c4c40619' | 视频换脸任务ID号 |
4、请求代码示例
建议您使用我们提供的SDK进行调用,SDK获取及调用方式详见本页一接口描述中的3接口使用
三、返回说明
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)业务返回参数
result参数信息
字段 | 类型 | 说明 |
---|---|---|
status | Int | 查询状态 0: 成功,非0为失败 |
message | String | 对状态码的信息描述 |
task_id | String | 透传任务ID号 |
task_status | Int | 任务状态 |
task_message | String | 任务信息说明 |
video_url | String | 换脸后的视频url地址 |
2、返回示例
{
"status": 0,
"message": "success",
"task_id": "c5721b2b7cdb488fafb1e065c4c40619",
"task_status": 2,
"task_message": "",
"video_url": "http://cvface-storage.s3.cn-north-1.jdcloud-oss.com/a.mp4"
}
四、错误码
1.系统级错误码
2.业务错误码
status状态码
错误号 | 错误信息 | 说明 |
---|---|---|
0 | success | 成功 |
101 | Parameters are missing | 参数缺失 |
102 | Task not found | 查无此任务 |
107 | Parameters are not json | 不合法的json入参 |
500 | Internal error | 内部错误 |
task_status状态码
错误号 | 错误信息 | 说明 |
---|---|---|
-1 | Task failed | 任务失败,返回具体message |
0 | Task not started | 任务未开始 |
1 | Task in progress | 任务进行中 |
2 | Task finished | 任务已完成 |