接入文档
FaceID星鉴
API接口
星鉴
星鉴

# 版本

1.0

# 描述

此接口用于深伪检测,识别传入的图片/视频是否为AI合成;基于大模型算法,有效防御人脸合成风险。

# 调用URL

https://api.megvii.com/faceid/v5/anti_deepfake

注意:在生产环境中,请使用HTTPS的通信方式。HTTP方式的通信属于不安全链路,存在安全风险,请勿在生产环境中使用。在生产环境中使用HTTP方式的,将无法得到服务可靠性保障。

# 调用方法

POST  注意:用 form-data 格式请求

# 权限

仅当用户接入FaceID产品后,才能调用FaceID各Web API。接入FaceID的流程请咨询FaceID商务人员。

# 参数

必选/可选 参数 类型 参数说明
必选 sign String 调用此API客户的签名,具体的签名产生方式请查阅鉴权说明
必选 sign_version String 签名算法版本号,目前仅支持:"hmac_sha1"。
必选 data_type int 数据类型 
0:image
1:video
必选 image File 待检测的图片, data_type=0时传入
传入图片建议如下:
  • 图片容量不大于10M,仅支持jpg、png格式
  • 图片分辨率建议480P(最大支持720P)
  • 人脸大小建议 100*100 以上
必选 video File 待检测的视频, data_type=1时传入
传入视频建议如下:
  • 视频要求为ffmpeg所支持的格式,Base64编码后的容量不大于10MB,视频建议时长为2~5s,不可超过20
  • 视频分辨率建议480P(最大支持720P),帧率在25fps~30fps之间
  • 人脸大小建议 100*100 以上
  • 视频支持正位检测,并自动旋转为正位

# 返回值说明

参数 类型 参数说明
request_id String 请求ID,用于区分每一次请求的唯一的字符串。
除了发生错误404(API_NOT_FOUND)外,此字段必定返回
time_used Int 请求耗时,整个请求所花费的时间,单位为毫秒
result Bool 深伪检测的结果。取值 True 或者 False ,False代表不是深伪,True代表是深伪
score Float 深伪检测的分数。取值[0,1],分数越高表明攻击的可能性越大
threshold Float 深伪检测阈值。取值[0,1],默认值为0.5
error String 错误信息,当请求失败时才会返回此字符串,具体返回内容见后续错误信息章节,否则此字段不存在。详见下方状态码

# 错误码

HTTP状态码 错误信息 说明
400 MISSING_ARGUMENTS:<key> 缺少某个必选参数
400 BAD_ARGUMENTS 某个参数解析出错(比如必须是数字,但是输入的是非数字字符串,或者长度过长),或者输入的图片/视频格式格式错误,解析失败
400 NO_FACE_FOUND 图片或视频中没有检测到人脸
400 INVALID_IMAGE_SIZE: 图片大小超限,有些时候会带key代表哪个字段超限
400 INTERNAL_TIMEOUT 请求超时
403 AUTHENTICATION_ERROR 无效签名
403 AUTHENTICATION_ERROR:<reason> api_key被停用、调用次数超限、没有调用此API的权限,或者没有以当前方式调用此API的权限 <reason>取值:
  • API_KEY_BE_DISCONTINUED:api_key被停用
  • IP_NOT_ALLOWED:不允许访问的IP(预留设计)
  • LIMIT_REACHED:这个api_key对当前API的调用量达到上限。仅当api_key为测试key
  • MORE_RETRY_TIMES:重试次数达到上限
  • DENIED:无权限调用当前API
  • EXPIRED_SIGN:签名已过期
  • INVALID_SIGN:无效签名
  • 其他可能的错误码,请预留处理方案
403 CONCURRENCY_LIMIT_EXCEEDED 并发数超过限制
404 API_NOT_FOUND 所调用的API不存在
413 Request Entity Too Large 客户发送的请求大小超过了限制。该错误的返回格式为纯文本,不是json格式
500 INTERNAL_ERROR 如果持续出现此类错误,请及时联系旷视客服或商务
504 504 Gateway Timeout 请求超时
该文档未解决您的疑问?查看常见问题