任务提交

更新时间:

请求规范

  • 请求 URL:

https://isafe.ilivedata.com/api/v2/image/check/async

  • 接口描述：

图片异步检测接口，图片信息提交后，会对图片进行检测，检测结果会通过回调方式返回，回调配置可在控制台服务配置中配置或者通过参数传入。

  • 图片要求：

    • 图片支持类型：URL, BASE64
    • 图片支持格式：jpg, png, bmp, gif, webp, tiff, heic
    • 图片大小：单张 < 10M
    • gif 图、长图说明：自动将 gif 图、长图（长宽比大于 5 的图片）截帧过检，最多 5 张，gif 图、长图均按照实际截图张数进行计费

  • HTTP 请求 Header：

Header 值 描述
Content-Type application/json;charset=UTF-8 请求体类型
Accept application/json;charset=UTF-8 接受的返回类型
X-AppId 项目的唯一标识，此值是 <控制台-服务配置> 中的项目编号
X-TimeStamp 请求的 UTC 时间戳。需要把时间戳按 W3C 标准格式化，例如: 2010-01-31T23:59:59Z。 (http://www.w3.org/TR/xmlschema-2/#dateTime)。
Authorization 签名值

  • 请求方法：POST

  • 请求体 JSON 对象：

参数 是否必需 类型 描述
type 必需 Number 图片内容类型：1：图片 URL；2：图片 BASE64 值
image 必需 String 图片内容。type=1 时为图片 URL；type=2 时为图片 BASE64 值
strategyId 可选 String 策略编号；不传时使用默认策略 DEFAULT
checkTags 可选 List<Number> 限定检测类别，支持传入策略中开启的一级类别
referImage 可选 String 人脸对比参照图，类型需与 image 一致。支持格式：jpg, png；大小 < 10M
userId 可选 String 唯一的终端用户 ID，不超过 32 个字符
extra 可选 json 扩展透传字段，可传多个 key/value。不得超过 20 个 key/value，单个 key 不得嵌套超过 3 层；若超出限制，后台审核日志将不会记录本次任务的 extra 值，但不影响 extra 透传响应
callbackUrl 可选 String 回调 URL（http 协议）
callbackSecretKey 可选 String 回调验签密钥，需与回调验签使用的密钥一致，否则无法验证回调数据是否被篡改
  • 请求体示例：
{
  "type": 1,
  "image": "http://abc.com/a.jpg",
  "userId": "123",
  "callbackUrl": "http://your.callback.url/callback"
}
  • 请求签名：

该接口需要在请求 Header 中传入 Authorization 签名。签名计算规则请参考帮助中心的请求签名。HTTPRequestURI 使用 /api/v2/image/check/async。

HTTP 响应

Content-Type: application/json;charset=UTF-8

结果为 JSON 格式。

  • 返回 json 字段说明：
字段名 类型 描述
errorCode Number 错误码：0 表示成功
errorMessage String 错误消息
taskId String 任务 ID，用于后续查询结果或关联回调
  • 返回结果示例：
{
  "errorCode": 0,
  "taskId": "ap_99b2bf004d4a4591bfedbba9574e74d4_1702882338368"
}

错误码

详见帮助中心的常见异常码